From b4eb39f308aa0460e2c76f7f780f90e940649af6 Mon Sep 17 00:00:00 2001 From: Kosta Ilic Date: Fri, 9 Jan 2026 19:09:14 -0600 Subject: [PATCH 1/2] I fixed links that were broken when I changed a subsection heading. I made a handful of related adjustments and improvements to the wording. Signed-off-by: Kosta Ilic --- CONTRIBUTING.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad548910..1ba5022c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,10 +30,8 @@ To contribute to this project, it is recommended that you follow these steps: version 2.1.3 or newer [installed](https://python-poetry.org/docs/#installation). 1. If you do not have write access to the repo, fork the repository on GitHub. 1. Install `nitypes` dependencies using `poetry install --with docs`. -1. Perform [Contributor Quality Assurance Activities](#contributor-quality-assurance-activities) -1. If all of the tests and checks covered under - [Contributor Quality Assurance Activities](#contributor-quality-assurance-activities) pass, - proceed to the next step. +1. Perform [Tests and Checks](#tests-and-checks) +1. If all the tests and checks pass, proceed to the next step. If you encounter any failures do not begin development. Instead, try to resolve those failures, and go back to the previous step. If you are unable to resolve the failures, report an issue through our [GitHub issues page](http://github.com/ni/nitypes-python/issues). @@ -41,17 +39,16 @@ To contribute to this project, it is recommended that you follow these steps: Ensure that the new tests fail. 1. Make your change. Remember to sign off your commits as described [above](#signing-off-commits). -1. Perform [Contributor Quality Assurance Activities](#contributor-quality-assurance-activities) -1. If all of the tests and checks covered under - [Contributor Quality Assurance Activities](#contributor-quality-assurance-activities) pass, - proceed to the next step. Otherwise, fix the failures and go back to the previous step. +1. Perform [Tests and Checks](#tests-and-checks) +1. If all of the tests and checks pass, proceed to the next step. + Otherwise, fix the failures and go back to the previous step where the problem was introduced. 1. Send a GitHub Pull Request to the main repository's `main` branch. GitHub Pull Requests are the expected method of code collaboration on this project. 1. Look at the checks on the checks on the Conversation tab in the PR. Note that if you are using a fork of the repo, the `Test Results` check will not complete due to a known issue (#243). - If any of the checks fails, attempt to fix the failures by changing the code. + If any of the tests or checks fails, attempt to fix the failures by changing the code. ## Tests and Checks From 311cdbab7d90bedb08f15575b8760e140de2fe24 Mon Sep 17 00:00:00 2001 From: Kosta Ilic Date: Fri, 9 Jan 2026 20:09:37 -0600 Subject: [PATCH 2/2] Replaced duplicated reference to checks with a better statement about tests and checks. Signed-off-by: Kosta Ilic --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ba5022c..58b2458a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ To contribute to this project, it is recommended that you follow these steps: Otherwise, fix the failures and go back to the previous step where the problem was introduced. 1. Send a GitHub Pull Request to the main repository's `main` branch. GitHub Pull Requests are the expected method of code collaboration on this project. -1. Look at the checks on the checks on the Conversation tab in the PR. +1. Look at the test and check results on the Conversation tab in the PR. Note that if you are using a fork of the repo, the `Test Results` check will not complete due to a known issue (#243).