Conversation
|
I would suggest adding What to consider when reviewing as well. It's technically written for a reviewer and not an author but I found it useful (especially the examples) when I first got started. At the end I think it's worth adding something to the end explaining that much of the work on a PR happens during review so it doesn't need to be perfect to start a request, though they obviously should have made effort on their own to stick to these guidelines. I think it's good to be encouraging to new contributors, the review process can be intimidating. As for length considerations, I have been using the rule of thumb that
To convince authors to follow length guidelines, it may be worth mentioning that limiting the length of a PR is good because
Final suggestion, perhaps it would be worth explaining the basics of the tag system since we don't have automated tools for it at the moment. |
Co-Authored-By: Daniel Morrison <39346894+morrison-daniel@users.noreply.github.com>
morrison-daniel
left a comment
There was a problem hiding this comment.
I fixed a couple spelling errors and am approving since it looks like no more changes are coming. Of course, feel free to keep editing if you like.
|
Many thanks, will merge now. We can always add more things later. |
Added review guidelines, very early draft that needs additions, but hopefully something which can be added to.