Code Review Manual/Guidelines for contributing document

karlcow commented 6 years ago

To set our expectations on a common basis and have uniformity, we should probably write a reference section on how to review code for the project when there is a pull request.

[ ] The goals of a code review
[ ] You have been asked, how long before answering?
[ ] You have been asked, but you do not have time, expertise, etc? What can you do?
[ ] How to get locally a pull request?
[ ] Manual testing?
[ ] Running the tests (which ones?)
[ ] Specifics for each language: JS, HTML, CSS, Python
[ ] Do/Don'ts. Good stuff in How to Do Code Reviews Like a Human (Part One) and How to Do Code Reviews Like a Human (Part Two)

Probably other things, feel free to chime in.

miketaylr commented 6 years ago

Hopefully the session on Friday on code quality will be relevant as well: https://wiki.mozilla.org/Compatibility/Meetings/2017-12-work-week#Friday_15 cc @zoepage

zoepage commented 6 years ago

Added this item to the list :) https://public.etherpad-mozilla.org/p/webcompat.com

kushinauwu commented 5 years ago

Hi, is this still up as an issue? If yes, can I contribute?

karlcow commented 5 years ago

@kushinauwu You could contribute, but I have the feeling that this issue requires a bit of knowledge of the project and how we do things. But certainly you create a first draft for it and we can see how we develop it.

Probably it could be done inside docs/ with the code-review-guide.md filename

webcompat / webcompat.com

Code Review Manual/Guidelines for contributing document #1975