-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Closes #5007 - Add PR guidelines to README. #5008
Conversation
Codecov Report
@@ Coverage Diff @@
## master #5008 +/- ##
========================================
Coverage 8.72% 8.72%
Complexity 192 192
========================================
Files 231 231
Lines 9137 9137
Branches 1326 1326
========================================
Hits 797 797
Misses 8287 8287
Partials 53 53 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
r+
Can we also include a comment mentioning to look at help wanted
tickets? Those are ones that we generally think are great for contributors to pick up 😄
README.md
Outdated
|
||
We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any other kind of positive contribution. | ||
* Every PR must have **exactly** one issue associated with it. | ||
* Write a clear explanation of what your PR is doing when opening the request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make a note here about also including self-comments on PR's when necessary rather than just a summary of the work? I find these to be more useful :)
README.md
Outdated
* Every PR must have **exactly** one issue associated with it. | ||
* Write a clear explanation of what your PR is doing when opening the request. | ||
* Keep PRs small and to the point. For extra code-health changes, either file a separate issue, or make it a separate PR that can be easily reviewed. | ||
* Use micro-commits - this makes it easier and faster to review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Use micro-commits. This makes it easier and faster to review.
I skipped the help-wanted mention bc it's already listed in under "good first issues" as well as in the I also added a part explaining why we might be slow handling PRs, which Jeff brought up. Some other things we could consider are making this more step-by-step, but in light of landing stuff early and iterating, I'm going to merge this in. Open to more feedback or re-opening the issue. |
Adding some PR guidelines that we discussed to the README. This also links to the shared android PR guidelines docs.
This is definitely only a first step!
I'd also consider: linking from the description of in the Fenix repo (at the top, where there's lots of visibility) to either this new PR section of the README, or copying the guidelines there directly.
I'll also send an email out, once we decide to merge this.
Open questions:
Pull Request checklist