Skip to content

Commit ef3753b

Browse files
committed
Address review comments
1 parent b427373 commit ef3753b

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,21 @@ project, you agree to abide by its terms.
1515

1616
This is the workflow for contributing changes to this project::
1717

18-
1. [Fork the git repository](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
19-
2. Clone your forked repository locally and install the development dependencies.
20-
3. Add a local remote "upstream" so you will be able to
21-
[synchronize your fork with the original repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).
22-
4. Create a local branch for your changes.
23-
5. Add unit tests for your changes.
18+
1. [Fork the Git repository](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
19+
2. Clone your forked repository locally and install the development
20+
dependencies.
21+
3. Create a local branch for your changes.
22+
4. Add unit tests for your changes.
2423
These tests should fail without your changes.
25-
6. Add your changes. Your added unit tests now should pass, and no other tests
24+
5. Add your changes. Your added unit tests now should pass, and no other tests
2625
should be broken. Check that your changes follow the same coding style as the
2726
rest of the project.
28-
7. Add a changelog entry.
29-
8. Commit and push your changes.
30-
9. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
31-
for your changes. Check that the CI build is green. (If it is not, fix the
32-
problems listed.)
27+
6. Add a changelog entry, newest on top.
28+
7. Commit and push your changes.
29+
8. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
30+
for your changes.
31+
9. Check that the CI build is green. (If it is not, fix the problems listed.)
32+
Please note that for first-time contributors, you will need to wait for a
33+
maintainer to approve your pull request before the CI build will run.
3334
10. Wait for a review by the maintainers.
3435
11. Polish your changes as needed until they are ready to be merged.

0 commit comments

Comments
 (0)