mat2/CONTRIBUTING.md

Contributing to MAT2

The main repository for MAT2 is on 0xacab, with a mirror on gitlab.com.

Do feel free to pick up an issue and to send a pull-request. Please do check that everything is fine by running the testsuite with python3 -m unittest discover -v before submitting one :)

If you're fixing a bug or adding a new feature, please add tests accordingly, this will greatly improve the odds of your merge-request getting merged.

If you're adding a new fileformat, please add tests for:

1. Getting metadata
2. Cleaning metadata
3. Raising ValueError upon a corrupted file

Since MAT2 is written in Python3, please conform as much as possible to the pep8 style; except where it makes no sense of course.

Doing a release

1. Update the changelog
2. Update the version in the mat2 file
3. Update the version in the setup.py file
4. Update the version and date in the man page
5. Commit the changelog, man page, mat2 and setup.py files
6. Create a tag with git tag -s $VERSION
7. Push the commit with git push origin master
8. Push the tag with git push --tags
9. Create the signed tarball with git archive --format=tar.xz --prefix=mat-$VERSION/ $VERSION > mat-$VERSION.tar.xz
10. Sign the tarball with gpg --armor --detach-sign mat-$VERSION.tar.xz
11. Upload the result on Gitlab's tag page and add the changelog there
12. Announce the release on the mailing list
13. Tell the downstreams about it
14. Do the secret release dance