summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3fcf788
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
1# Contributing to MAT2
2
3The main repository for MAT2 is on [0xacab]( https://0xacab.org/jvoisin/mat2 ),
4with a mirror on [gitlab.com]( https://gitlab.com/jvoisin/mat2 ).
5
6Do feel free to pick up [an issue]( https://0xacab.org/jvoisin/mat2/issues )
7and to send a pull-request. Please do check that everything is fine by running the
8testsuite with `python3 -m unittest discover -v` before submitting one :)
9
10# Doing a release
11
121. Update the [changelog](https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md)
132. Update the version in the [main.py](https://0xacab.org/jvoisin/mat2/blob/master/main.py) file
143. Commit the changelog and the main.py file
154. Create a tag with `git tag -s $VERSION`
165. Push the tag with `git push --tags`