|
1 | | -# CONTRIBUTION PROCESS |
2 | | -To contribute to this repository, please create a branch on your local |
3 | | -clone, push that branch to the repository, and create a Pull Request (PR) |
4 | | -for that branch. No commits can be directly added onto `master` - all |
5 | | -must come via a Pull Request. |
6 | | - |
7 | | -### Reviewers |
8 | | -All PRs must be approved by at least 2 reviewers before they can be merged. |
9 | | -Any team members can act as reviewers, but it is suggested that in general |
10 | | -each PR should have one reviewer from the 'software development' angle, and |
11 | | -one reviewer from the 'data science' angle. All team members (dependent on |
12 | | -their notifications settings) will be notified of new PRs, and are encouraged |
13 | | -to provide additional review comments whenever they can. |
14 | | - |
15 | | -### Work items |
16 | | -Please link each PR to a work item from the current sprint. If no work items |
17 | | -are linked, the PR cannot be merged - a new work item should be raised in |
18 | | -order to facilitate capturing the work being done. |
19 | | - |
20 | | -If you reference a work item by id in a commit message - e.g. #12345 |
21 | | -Fixed issue where data was eaten by a grue - DevOps will auto link the item |
22 | | -to the commit, and therefore the PR. |
23 | | - |
24 | | -Otherwise you can manually link items at the point of PR creation, or |
25 | | -afterwards, if necessary. |
26 | | - |
27 | | -### Formatting |
28 | | -Please adhere to PEP8 (https://www.python.org/dev/peps/pep-0008/), the |
29 | | -Python Style Guide. In particular, please |
30 | | - |
31 | | -1) Indent with 4 spaces (not tabs). |
32 | | -1) Place 2 blank lines between top-level function and class definitions. |
33 | | -1) Place 1 blank line around method definitions within a class. |
34 | | -1) Place import statements at the top of the file, after any module comments |
35 | | -and docstrings. |
36 | | -1) Include a docstring for each function unless the function is extremely |
37 | | -trivial - if in doubt, err on the side of more documentation. See |
38 | | -https://www.python.org/dev/peps/pep-0257/ for full guidance on writing docstrings. |
39 | | -Note the use of triple-double quotes (""") to start and end docstrings. |
40 | | - |
41 | | -### Testing |
42 | | -All PRs should also contain tests that test the functionality within |
43 | | -the PR. |
44 | | - |
45 | | -### Continuous integration |
46 | | -In the near future, Continuous Integration tests will run on each PR, to |
47 | | -ensure that all tests pass before the PR can be merged into `master`. |
48 | | -More details will be available when this is in place. |
| 1 | +# Contributing |
49 | 2 |
|
| 3 | +See the [contribution guide](https://carrot.ac.uk/contributing) for details. |
0 commit comments