Skip to content

Commit f5ea785

Browse files
authored
[DOCS] Explain code reviews in CONTRIBUTING.md (#752)
This change copies the corresponding section from our sister project.
1 parent 35c0389 commit f5ea785

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,20 @@ This is the workflow for contributing changes to this project::
3333
maintainer to allow your CI build to run.
3434
1. Wait for a review by the maintainers.
3535
1. Polish your changes as needed until they are ready to be merged.
36+
37+
## About code reviews
38+
39+
After you have submitted a pull request, the maintainers will review your
40+
changes. This will probably result in quite a few comments on ways to improve
41+
your pull request. This project receives contributions from developers around
42+
the world, so we need the code to be the most consistent, readable, and
43+
maintainable that it can be.
44+
45+
Please do not feel frustrated by this - instead please view this both as our
46+
contribution to your pull request as well as a way to learn more about
47+
improving code quality.
48+
49+
If you would like to know whether an idea would fit in the general strategy of
50+
this project or would like to get feedback on the best architecture for your
51+
ideas, we propose you open a ticket first and discuss your ideas there
52+
first before investing a lot of time in writing code.

0 commit comments

Comments
 (0)