Skip to content

Fixed broken links in CONTRIBUTING.md file #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bkeryan merged 2 commits into from
Jan 13, 2026
Merged

Fixed broken links in CONTRIBUTING.md file #253

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4eb39f
I fixed links that were broken when I changed a subsection heading. I…
KostaIlic2 Jan 10, 2026
311cdba
Replaced duplicated reference to checks with a better statement about…
KostaIlic2 Jan 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,28 +30,25 @@ 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).
1. Write new tests that demonstrate your bug or feature. Run regression tests.
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.
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).

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

Expand Down
Loading