Skip to content

Commit 47de090

Browse files
committed
Eliminated some duplication from getting started section by introducing a new subsection. Demoted two sections to subsections.
Signed-off-by: Kosta Ilic <[email protected]>
1 parent 8f18f2c commit 47de090

File tree

2 files changed

+26
-21
lines changed

2 files changed

+26
-21
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,28 +30,21 @@ To contribute to this project, it is recommended that you follow these steps:
3030
version 2.1.3 or newer [installed](https://python-poetry.org/docs/#installation).
3131
1. If you do not have write access to the repo fork the repository on GitHub.
3232
1. Install `nitypes` dependencies using `poetry install --with docs`.
33-
1. Perform regression tests per [Regression Tests](#regression-tests) section below.
34-
1. Perform static analysis checks per [Static Analysis Checks](#static-analysis-checks)
35-
section below.
36-
1. If your changes will cover documentation generated from the code, generate that
37-
documentation per
38-
[Documentation Generated from the Code](#documentation-generated-from-the-code) section.
39-
1. If you are concerned that your changes may have negative impact on performance,
40-
perform benchmark test per [Benchmark Tests](#benchmark-tests)
41-
1. If all of the tests and checks listed above pass, proceed to the next step.
33+
1. Perform [Contributor Quality Assurance Activities](#contributor-quality-assurance-activities)
34+
1. If all of the tests and checks covered under
35+
[Contributor Quality Assurance Activities](#contributor-quality-assurance-activities) pass,
36+
proceed to the next step.
4237
If you encounter any failures do not begin development. Instead, try to resolve
43-
those failures. If you are unable to resolve the failures, report an
44-
issue through our [GitHub issues page](http://github.com/ni/nitypes-python/issues).
45-
1. Write new tests that demonstrate your bug or feature. Ensure that these new tests fail.
38+
those failures, and go back to the previous step. If you are unable to resolve the failures,
39+
report an issue through our [GitHub issues page](http://github.com/ni/nitypes-python/issues).
40+
1. Write new tests that demonstrate your bug or feature. Run regression tests.
41+
Ensure that the new tests fail.
4642
1. Make your change. Remember to sign off your commits as described
4743
[above](#signing-off-commits).
48-
1. Run all the regression tests again, including the tests you just added.
49-
If there are any failures, fix them by changing the code or the test, as appropriate, before
50-
moving to the next step.
51-
1. Perform all the static analysis checks. If there are any failures, fix them.
52-
1. If applicable, generate documentation and review generated documentation. If there are any
53-
failures, fix them.
54-
1. If applicable, perform benchmark tests. If there are any failures, fix them.
44+
1. Perform [Contributor Quality Assurance Activities](#contributor-quality-assurance-activities)
45+
1. If all of the tests and checks covered under
46+
[Contributor Quality Assurance Activities](#contributor-quality-assurance-activities) pass,
47+
proceed to the next step. Otherwise, fix the failures and go back to the previous step.
5548
1. Send a GitHub Pull Request to the main repository's `main` branch. GitHub Pull Requests are
5649
the expected method of code collaboration on this project.
5750
1. Look at the checks on the checks on the Conversation tab in the PR.
@@ -60,7 +53,19 @@ To contribute to this project, it is recommended that you follow these steps:
6053

6154
If any of the checks fails, attempt to fix the failures by changing the code.
6255

63-
# Regression Tests
56+
## Contributor Quality Assurance Activities
57+
58+
As a contributor, you are expected to perform the following quality assurance activities:
59+
1. Perform regression tests per [Regression Tests](#regression-tests) section below.
60+
1. Perform static analysis checks per [Static Analysis Checks](#static-analysis-checks)
61+
section below.
62+
1. If your changes will cover documentation generated from the code, generate that
63+
documentation per
64+
[Documentation Generated from the Code](#documentation-generated-from-the-code) section.
65+
1. If you are concerned that your changes may have negative impact on performance,
66+
perform benchmark test per [Benchmark Tests](#benchmark-tests)
67+
68+
## Regression Tests
6469

6570
In order to be able to run the `nitypes` regression tests, your setup should meet the following minimum
6671
requirements:
@@ -70,7 +75,7 @@ requirements:
7075

7176
To perform regression tests, run `poetry run pytest -v` in the root of the distribution.
7277

73-
# Static Analysis Checks
78+
## Static Analysis Checks
7479

7580
Static analysis is performed in several steps, as set forth below. Run each of the commands listed below in the root of the distribution.
7681

images/pr-checks.png

-141 KB
Binary file not shown.

0 commit comments

Comments
 (0)