|
2 | 2 |
|
3 | 3 | ## Table of Contents <!-- omit in toc -->
|
4 | 4 | - [Contributing](#contributing)
|
| 5 | + - [Issue vs. Pull Request](#issue-vs-pull-request) |
5 | 6 | - [Templates](#templates)
|
6 | 7 | - [Why Contributing?](#why-contributing)
|
| 8 | +- [Contribution FAQs](#contribution-faqs) |
| 9 | + - [Reviewer Role](#reviewer-role) |
| 10 | + - [Review Feedback](#review-feedback) |
| 11 | + - [Merge Readiness](#merge-readiness) |
| 12 | + - [Review Validity](#review-validity) |
7 | 13 | - [Environment Setup](#environment-setup)
|
8 | 14 | - [Recommended Tools](#recommended-tools)
|
9 | 15 | - [Setting up your local machine](#setting-up-your-local-machine)
|
@@ -87,6 +93,42 @@ Consider the benefits you get:
|
87 | 93 |
|
88 | 94 | Most importantly, with every contribution you improve your skills so that future contributions take even less time and you get all the benefits above for free — easy choice, right?
|
89 | 95 |
|
| 96 | +## Contribution FAQs |
| 97 | + |
| 98 | +### Reviewer Role |
| 99 | + |
| 100 | +> *Instead of writing review comments back-and-forth, why doesn't the reviewer just write the code themselves?* |
| 101 | +
|
| 102 | +A reviewer is already helping you to make a code contribution through their review. A reviewer *may* even help you to write code by actually writing it for you, but is not obliged to do so. |
| 103 | + |
| 104 | +### Review Feedback |
| 105 | + |
| 106 | +> *It takes too much effort to incorporate the review feedback, why why can't you just merge my pull request?* |
| 107 | +
|
| 108 | +If you are a new contributor, it's naturally a learning experience for you and therefore takes longer. We welcome contributors of any experience levels and gladly support you in getting familiar with the code base and our quality standards and contribution requirements. In return we expect you to be open to and appreciative of the reviewers' feedback. |
| 109 | + |
| 110 | +In a large pull request, it can be a significant effort to bring it over the finish line. Luckily this is a collaborative environment and others are free to jump in to contribute to the pull request to share the effort. You can either give others access to your fork or they can open their own pull request based on your previous work. |
| 111 | + |
| 112 | +If you are out of resources stay calm, explain your personal constraints (expertise or time) and ask for help. Wasting time by complaining about the amount of review comments will neither use your own time in a meaningful way, nor the time of others who read your complaint. |
| 113 | + |
| 114 | +**❗️ Always be mindful that the reviewers' efforts are an integral part of code contribution. Their review is as important as your written code. Keep in mind that their review time is a valuable as your coding time.** |
| 115 | + |
| 116 | +### Merge Readiness |
| 117 | + |
| 118 | +> *The feature already works, why do you request more changes instead of just merging my pull request?* |
| 119 | +
|
| 120 | +A feature may work for your own use case or in your own environment, but that doesn't necessarily mean that it's ready for merging. Aside from code quality and code style requirements, reviewers also review based on strategic and architectural considerations. It's often easy to just get a feature to work, but it needs to be also maintained in the future, robust therefore well tested and validated, intuitive for other developers to use, well documented, and not cause a forseeable breaking change in the near future. |
| 121 | + |
| 122 | +### Review Validity |
| 123 | + |
| 124 | +> *The reviewer has never worked on the issue and was never part of any previous discussion, why would I care about their opinion?* |
| 125 | +
|
| 126 | +It's contrary to an open, collaborative environment to expect others to be involved in an issue or discussion since its beginning. Such a mindset would close out any new views from other people, which are important for a differentiated view. |
| 127 | + |
| 128 | +> *The reviewer doesn't have any expertise in that matter, why would I care about their opinion?* |
| 129 | +
|
| 130 | +Your arguments must focus on the issue, not on your assumption of someone else's personal experience. We will take immediate and appropriate action in case of personal attacks, regardless of your previous contributions. Personal attacks are not permissible. If you are a reviewer who became a victim of personal attacks, you can privately [report](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) the GitHub comment to the PMC. |
| 131 | + |
90 | 132 | ## Environment Setup
|
91 | 133 |
|
92 | 134 | ### Recommended Tools
|
|
0 commit comments