codeReview

codeReview copied to clipboard

As of January 1 2019, Mozilla requires that all GitHub projects include this [CODE_OF_CONDUCT.md](https://github.com/mozilla/repo-templates/blob/master/templates/CODE_OF_CONDUCT.md) file in the project root. The file has two parts: 1. Required Text - All text...

ghost

Mechanics of code review

3

@stephenturner suggested on the SWC list lessons on how to run code from a PR locally before merging the pull - an excellent suggestion! I personally have always got by...

bkatiemills

We need to come up with some activities for teaching about good documentation. Activities in this repo should be - highly interactive - designed for a small group of around...

bkatiemills

Discuss squashing commits

3

Should you recommend squashing commits as a practice for submitting code to review/merge?

codersquid

Project structures

1

I'm not sure how relevant project structures are to code review, but I think they are equally as important in terms of people knowing where to find things. There are...

chendaniely

Code review by yourself

3

Steve Eddins from Mathworks made a reference to [this book](http://www.amazon.com/Write-Great-Code-Understanding-Machine-ebook/dp/B0096FEJGQ/ref=sr_1_2?s=books&ie=UTF8&qid=1412024799&sr=1-2&keywords=write+good+code) (IIRC) when I asked him about how to conduct code reviews when you do not have someone else to review...

chendaniely

Guidelines for frequency of code reviews

2

Consider adding guidelines for frequency of code reviews. I suggest very frequent code reviews.

codersquid

Guidelines for submitting related code changes

1

Consider adding guidelines to encourage contributors to submit code reviews for logical changesets. That is jargon. If you decide to suggest it, figure out a concise way to explain it...

codersquid