Skip to content

Commit 2f3ad85

Browse files
taldcrofteteq
andauthored
Apply suggestions from code review
Co-authored-by: Erik Tollerud <[email protected]>
1 parent 5d2d1cf commit 2f3ad85

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

policies/pull-request-review-and-merge.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ In the astropy core package the requirements are as follows:
66

77
- At least one contributor with relevant expertise must review the pull request
88
in detail.
9-
- New or updated code is logically correct and achieves the desired effect of
9+
- New or updated code is correct and achieves the desired effect of
1010
either fixing a bug or making an enhancement.
1111
- New tests or modifications to tests are adequate to cover the code changes.
12-
Tests for edge cases exist, if applicable.
12+
Tests for edge cases exist, if applicable and judged to be important enough.
1313
- There are no API changes or the API changes are well-understood and
14-
acceptable and beneficial on the whole to the astropy user community.
14+
acceptable and beneficial on the whole to the astropy user community, and documented as an API change in the changelog.
1515
- The expected level of review is detailed, including review and suggestions
16-
at the line-by-line level. Formatting and style are acceptable points for
16+
at the line-by-line level (although "I looked and had no comments" is a valid answer). Formatting and style are acceptable points for
1717
comment, in particular to maintain the existing coding style of a package and to
1818
maintain readability of the code base for future developers.
1919
- Maintainer(s) of subpackages that the contribution affects are required to
@@ -35,7 +35,7 @@ In the astropy core package the requirements are as follows:
3535
platforms. Even the CI job that is allowed to fail should pass unless
3636
an known and unrelated failure occurs; i.e., look at the logs even in
3737
the event of green check mark.
38-
- A bot checks that the change log mentions the change and PR number and that the change log
38+
- An automated tool checks that the change log mentions the change and PR number and that the change log
3939
section used matches the selected release milestone set by the maintainer.
4040
- Merging the pull request can be done by any core package maintainer once
4141
approved by relevant maintainers (as described above). In practice this is
@@ -63,3 +63,4 @@ affiliated package may make their requirements as rigorous as they’d like.
6363
- Independent review is encouraged but is at the discretion of the package
6464
maintainer(s). In particular some packages may be largely developed by a
6565
single maintainer.
66+
- For affiated packages with enough contributors, the workflow for the core/coordinated packages is recommended, although not required.

0 commit comments

Comments
 (0)