diff options
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. |