diff options
| author | Denis 'GNUtoo' Carikli | 2021-12-09 17:13:51 +0100 |
|---|---|---|
| committer | Denis 'GNUtoo' Carikli | 2021-12-09 17:16:34 +0100 |
| commit | b71bafd2cfaec838844447676f9fae30abe432ef (patch) | |
| tree | 4b7edf54de2bbb047daa7bb2d808ecca69f90c05 /CONTRIBUTING.md | |
| parent | 22199df4d0f7abb83cfede9949a1ae54521c8349 (diff) | |
CONTRIBUTING.md: Update information about tests
Contributors are now supposed to run tests in the GitLab instance, so
this also needs to be reflected in the CONTRIBUTING.md as otherwise
people not used to forge workflows could completely miss that
information.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34dfe23..a252462 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -4,8 +4,14 @@ The main repository for mat2 is on [0xacab]( https://0xacab.org/jvoisin/mat2 ), | |||
| 4 | but you can send patches to jvoisin by [email](https://dustri.org/) if you prefer. | 4 | but you can send patches to jvoisin by [email](https://dustri.org/) if you prefer. |
| 5 | 5 | ||
| 6 | Do feel free to pick up [an issue]( https://0xacab.org/jvoisin/mat2/issues ) | 6 | Do feel free to pick up [an issue]( https://0xacab.org/jvoisin/mat2/issues ) |
| 7 | and to send a pull-request. Please do check that everything is fine by running the | 7 | and to send a pull-request. |
| 8 | testsuite with `python3 -m unittest discover -v` before submitting one :) | 8 | |
| 9 | Before sending the pull-request, please do check that everything is fine by | ||
| 10 | running the full test suite in GitLab. To do that, after forking mat2 in GitLab, | ||
| 11 | you need to go in Settings -> CI/CD -> Runner and there enable shared runners. | ||
| 12 | |||
| 13 | Mat2 also has unit tests (that are also run in the full test suite). You can run | ||
| 14 | them with `python3 -m unittest discover -v`. | ||
| 9 | 15 | ||
| 10 | If you're fixing a bug or adding a new feature, please add tests accordingly, | 16 | If you're fixing a bug or adding a new feature, please add tests accordingly, |
| 11 | this will greatly improve the odds of your merge-request getting merged. | 17 | this will greatly improve the odds of your merge-request getting merged. |