... | ... | @@ -24,7 +24,7 @@ |
|
|
|
|
|
- Explain what problem a given commit solves or what new feature it adds.
|
|
|
|
|
|
- Try hard to avoid being overly terse and/or vague - the reader is very unlikely to be acquainted with the context and/or motivation behind your work. As the author of a change, it is your job to explain why it is needed.
|
|
|
- Try hard to avoid being overly terse and/or vague - the reader is very unlikely to be acquainted with the context and/or motivation behind your work. As the author of a change, it is your duty to explain why it is needed - the reviewer is not supposed to be making guesses about what you are trying to achieve.
|
|
|
|
|
|
- If applicable, briefly discuss alternative solutions which were also considered, but ultimately rejected.
|
|
|
|
... | ... | |