summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2017-10-31 09:18:15 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2017-11-02 12:49:30 +0000
commit09e57d228c75dec9699ce5f45c8b1a84fe13a0bb (patch)
tree46052b72dc39c24c19df8ff8f11ef3ff05b177bb
parent3241f09bad7620c83385338d21f0cdc91bca388a (diff)
downloadgnutls-tmp-review-guidelines.tar.gz
CONTRIBUTING.md: added a short text on reviewing code [ci skip]tmp-review-guidelines
Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>
-rw-r--r--CONTRIBUTING.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bec4f00284..7947f7e6d2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -267,3 +267,24 @@ two things must be done:
Note that, for constants and enums, "schemefied" names are used, as
noted under the "Guile API Conventions" node of the manual.
+
+
+# Reviewing code
+
+A review as part of the gitlab merge requests, is a way to prevent errors due to
+these guidelines not being followed, e.g., verify there is a reasonable test suite,
+and whether it covers reasonably the new code, that the function naming is
+consistent with these guidelines, as well as check for obvious mistakes in the new
+code.
+
+The intention is to keep reviews lightweight, and rely on CI for tasks such
+as compiling and testing code and features.
+
+A proposed checklist to assist such reviews follows.
+ * [ ] There is a test suite reasonably covering new functionality or modifications
+ * [ ] Function naming, parameters, return values, types, etc., are consistent and according to `CONTRIBUTION.md`
+ * [ ] This feature/change has adequate documentation added
+ * [ ] No obvious mistakes in the code
+
+
+[Guidelines to consider when reviewing.](https://github.com/thoughtbot/guides/tree/master/code-review)