Update CONTRIBUTING.md with tips for successful PRs #2598
Conversation
There was a problem hiding this comment.
Thanks @GaryJones ! LGTM.
Only thing I'm unsure about is the "draft PR" bit.
In my opinion, draft PRs should only be allowed temporarily, but are often used as "WIP" placeholders or even just a demo of a concept.
The downsides of this are:
- They are noisy - every time a commit is pushed to an open draft PR, maintainers get email notifications.
- The PR list keeps getting longer with PR which are not actionable (as draft/unfinished).
With that in mind, I'm not sure encouraging people to open draft PRs is a good idea.
dingo-d
left a comment
dingo-d
left a comment
There was a problem hiding this comment.
Left a few suggestions. I also agree with what Juliette mentioned. Better to leave discussions for issues and discussions than having draft PRs. As PRs would need to get reviewed to understand what a person wanted to do, and that takes time.
Co-authored-by: Denis Žoljom <[email protected]>
Co-authored-by: Denis Žoljom <[email protected]>
Co-authored-by: Denis Žoljom <[email protected]>
|
Suggestions all merged. Thank you - I agree with them. Another else needed? |
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
Thanks for making those updates @GaryJones !
See #2594.
We want contributors to be successful with their PRs, but we need to balance that with the limited time that maintainers have. This PR updates the
CONTRIBUTING.mdfile to guide new users, and provides a place to direct authors of PRs who have missed the memo.The first commit here fixes up the heading levels, as there were multiple level 1's, which translate as multiple
h1elements, which is bad for accessibility.The second commit is the additional text.