Skip to content

Commit b0d6c4e

Browse files
authored
[TASK] Document the general contribution workflow (#662)
Part of #489
1 parent a8e91c9 commit b0d6c4e

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,26 @@ When you contribute, please take the following things into account:
1010
Please note that this project is released with a
1111
[Contributor Code of Conduct](../CODE_OF_CONDUCT.md). By participating in this
1212
project, you agree to abide by its terms.
13+
14+
## General workflow
15+
16+
This is the workflow for contributing changes to this project::
17+
18+
1. [Fork the Git repository](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
19+
1. Clone your forked repository locally and install the development
20+
dependencies.
21+
1. Create a local branch for your changes.
22+
1. Add unit tests for your changes.
23+
These tests should fail without your changes.
24+
1. Add your changes. Your added unit tests now should pass, and no other tests
25+
should be broken. Check that your changes follow the same coding style as the
26+
rest of the project.
27+
1. Add a changelog entry, newest on top.
28+
1. Commit and push your changes.
29+
1. [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+
1. 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 allow your CI build to run.
34+
1. Wait for a review by the maintainers.
35+
1. Polish your changes as needed until they are ready to be merged.

0 commit comments

Comments
 (0)