You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+22Lines changed: 22 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -10,3 +10,25 @@ When you contribute, please take the following things into account:
10
10
Please note that this project is released with a
11
11
[Contributor Code of Conduct](../CODE_OF_CONDUCT.md). By participating in this
12
12
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
+
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.
24
+
These tests should fail without your changes.
25
+
6. Add your changes. Your added unit tests now should pass, and no other tests
26
+
should be broken. Check that your changes follow the same coding style as the
27
+
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.)
33
+
10. Wait for a review by the maintainers.
34
+
11. Polish your changes as needed until they are ready to be merged.
0 commit comments