diff options
| author | Alex Stapleton <alexs@prol.etari.at> | 2014-03-29 13:26:10 +0000 |
|---|---|---|
| committer | Alex Stapleton <alexs@prol.etari.at> | 2014-03-29 13:26:10 +0000 |
| commit | a678ae01da79208019b245aa4999e6a289de87db (patch) | |
| tree | c0f19b9c4957df122ad25be5bcf62a50f10670d0 /docs | |
| parent | 50b23b0409c4f0288c96cca89838999ed77a1608 (diff) | |
| download | cryptography-a678ae01da79208019b245aa4999e6a289de87db.tar.gz cryptography-a678ae01da79208019b245aa4999e6a289de87db.tar.bz2 cryptography-a678ae01da79208019b245aa4999e6a289de87db.zip | |
Make code review docs friendlier
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/reviewing-patches.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/development/reviewing-patches.rst b/docs/development/reviewing-patches.rst index 9147a731..bd3ee96a 100644 --- a/docs/development/reviewing-patches.rst +++ b/docs/development/reviewing-patches.rst @@ -1,8 +1,11 @@ -Reviewing/merging patches -========================= +Reviewing and merging patches +============================= -Everyone is encouraged to review open pull requests. When reviewing a patch try -to keep each of these concepts in mind: +Everyone is encouraged to review open pull requests. We only ask that you try +and think carefully, ask questions and are `excellent to one another`_. Code +review is our opportunity to share knowledge, design ideas and make friends. + +When reviewing a patch try to keep each of these concepts in mind: Architecture ------------ @@ -24,8 +27,8 @@ Implementation * Has it been documented? * Will this change introduce new bugs? -Grammar/Style -------------- +Grammar and style +----------------- These are small things that are not caught by the automated style checkers. @@ -54,3 +57,4 @@ devastating, ``cryptography`` has a strict merge policy for committers: The purpose of these policies is to minimize the chances we merge a change that jeopardizes our users' security. +.. _`excellent to one another`: https://speakerdeck.com/ohrite/better-code-review |