@@ -37,3 +37,32 @@ For example, for running tests in `multi`, `uuid` and `main` packages, call
37
37
``` bash
38
38
make test-multi test-uuid test-main
39
39
```
40
+
41
+ ## Code review checklist
42
+
43
+ - Public API contains functions, variables, constants that are needed from
44
+ outside by users. All the rest should be left closed.
45
+ - Public functions, variables and constants contain at least a single-line
46
+ comment.
47
+ - Code is DRY (see "Do not Repeat Yourself" principle).
48
+ - New features have functional and probably performance tests.
49
+ - There are no changes in files not related to the issue.
50
+ - There are no obvious flaky tests.
51
+ - Commits with bugfixes have tests based on reproducers.
52
+ - Changelog entry is present in ` CHANGELOG.md ` .
53
+ - Public methods contain executable examples (contains a comment with
54
+ reference output).
55
+ - Autogenerated documentation looks good. Run ` godoc -http=:6060 ` and point
56
+ your web browser to address "http://127.0.0.1:6060 " for evaluating.
57
+ - Commit message header may start with a prefix with a short description
58
+ follows after colon. It is applicable to changes in a README, examples, tests
59
+ and CI configuration files. Examples: ` github-ci: add Tarantool 2.x-latest `
60
+ and ` readme: describe how to run tests ` .
61
+ - Check your comments, commit title, and even variable names to be
62
+ grammatically correct. Start sentences from a capital letter, end with a dot.
63
+ Everywhere - in the code, in the tests, in the commit message.
64
+
65
+ See also:
66
+
67
+ - https://github.com/tarantool/tarantool/wiki/Code-review-procedure
68
+ - https://www.tarantool.io/en/doc/latest/contributing/
0 commit comments