2019-11-28 03:15:20 +01:00
|
|
|
# Contributing to mat2
|
2018-05-14 22:44:54 +02:00
|
|
|
|
2019-11-28 03:15:20 +01:00
|
|
|
The main repository for mat2 is on [0xacab]( https://0xacab.org/jvoisin/mat2 ),
|
2019-03-06 22:03:31 +01:00
|
|
|
but you can send patches to jvoisin by [email](https://dustri.org/) if you prefer.
|
2018-05-14 22:44:54 +02:00
|
|
|
|
|
|
|
|
Do feel free to pick up [an issue]( https://0xacab.org/jvoisin/mat2/issues )
|
2021-12-09 17:13:51 +01:00
|
|
|
and to send a pull-request.
|
|
|
|
|
|
|
|
|
|
Before sending the pull-request, please do check that everything is fine by
|
|
|
|
|
running the full test suite in GitLab. To do that, after forking mat2 in GitLab,
|
|
|
|
|
you need to go in Settings -> CI/CD -> Runner and there enable shared runners.
|
|
|
|
|
|
|
|
|
|
Mat2 also has unit tests (that are also run in the full test suite). You can run
|
|
|
|
|
them with `python3 -m unittest discover -v`.
|
2018-05-14 22:44:54 +02:00
|
|
|
|
2018-06-07 00:11:50 +02:00
|
|
|
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.
|
|
|
|
|
|
2018-06-22 21:21:03 +02:00
|
|
|
If you're adding a new fileformat, please add tests for:
|
|
|
|
|
|
|
|
|
|
1. Getting metadata
|
|
|
|
|
2. Cleaning metadata
|
|
|
|
|
3. Raising `ValueError` upon a corrupted file
|
|
|
|
|
|
2019-11-28 03:15:20 +01:00
|
|
|
Since mat2 is written in Python3, please conform as much as possible to the
|
2018-07-02 00:27:38 +02:00
|
|
|
[pep8]( https://pep8.org/ ) style; except where it makes no sense of course.
|
|
|
|
|
|
2018-05-14 22:44:54 +02:00
|
|
|
# Doing a release
|
|
|
|
|
|
|
|
|
|
1. Update the [changelog](https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md)
|
2018-06-21 23:33:56 +02:00
|
|
|
2. Update the version in the [mat2](https://0xacab.org/jvoisin/mat2/blob/master/mat2) file
|
2018-05-21 22:53:48 +02:00
|
|
|
3. Update the version in the [setup.py](https://0xacab.org/jvoisin/mat2/blob/master/setup.py) file
|
2023-08-02 21:09:12 +02:00
|
|
|
4. Update the version in the [pyproject.toml](https://0xacab.org/jvoisin/mat2/blob/master/yproject.toml) file
|
|
|
|
|
5. Update the version and date in the [man page](https://0xacab.org/jvoisin/mat2/blob/master/doc/mat2.1)
|
|
|
|
|
6. Commit the modified files
|
|
|
|
|
7. Create a tag with `git tag -s $VERSION`
|
|
|
|
|
8. Push the commit with `git push origin master`
|
|
|
|
|
9. Push the tag with `git push --tags`
|
|
|
|
|
10. Download the gitlab archive of the release
|
|
|
|
|
11. Diff it against the local copy
|
|
|
|
|
12. If there is no difference, sign the archive with `gpg --armor --detach-sign mat2-$VERSION.tar.xz`
|
|
|
|
|
13. Upload the signature on Gitlab's [tag page](https://0xacab.org/jvoisin/mat2/tags) and add the changelog there
|
|
|
|
|
14. Announce the release on the [mailing list](https://mailman.boum.org/listinfo/mat-dev)
|
|
|
|
|
15. Sign'n'upload the new version on pypi with `python3 setup.py sdist bdist_wheel` then `twine upload -s dist/*`
|
|
|
|
|
16. Do the secret release dance
|
