diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69146e7..1e663a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -1,9 +1,9 @@ | |||
| 1 | # Contributing to mat2 | 1 | # Contributing to mat2 |
| 2 | 2 | ||
| 3 | The main repository for mat2 is on [0xacab]( https://0xacab.org/jvoisin/mat2 ), | 3 | The main repository for mat2 is on [github]( https://github.com/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://github.com/jvoisin/mat2/issues ) |
| 7 | and to send a pull-request. | 7 | and to send a pull-request. |
| 8 | 8 | ||
| 9 | Before sending the pull-request, please do check that everything is fine by | 9 | Before sending the pull-request, please do check that everything is fine by |
| @@ -27,11 +27,11 @@ Since mat2 is written in Python3, please conform as much as possible to the | |||
| 27 | 27 | ||
| 28 | # Doing a release | 28 | # Doing a release |
| 29 | 29 | ||
| 30 | 1. Update the [changelog](https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md) | 30 | 1. Update the [changelog](https://github.com/jvoisin/mat2/blob/master/CHANGELOG.md) |
| 31 | 2. Update the version in the [mat2](https://0xacab.org/jvoisin/mat2/blob/master/mat2) file | 31 | 2. Update the version in the [mat2](https://github.com/jvoisin/mat2/blob/master/mat2) file |
| 32 | 3. Update the version in the [setup.py](https://0xacab.org/jvoisin/mat2/blob/master/setup.py) file | 32 | 3. Update the version in the [setup.py](https://github.com/jvoisin/mat2/blob/master/setup.py) file |
| 33 | 4. Update the version in the [pyproject.toml](https://0xacab.org/jvoisin/mat2/blob/master/yproject.toml) file | 33 | 4. Update the version in the [pyproject.toml](https://github.com/jvoisin/mat2/blob/master/yproject.toml) file |
| 34 | 5. Update the version and date in the [man page](https://0xacab.org/jvoisin/mat2/blob/master/doc/mat2.1) | 34 | 5. Update the version and date in the [man page](https://github.com/jvoisin/mat2/blob/master/doc/mat2.1) |
| 35 | 6. Commit the modified files | 35 | 6. Commit the modified files |
| 36 | 7. Create a tag with `git tag -s $VERSION` | 36 | 7. Create a tag with `git tag -s $VERSION` |
| 37 | 8. Push the commit with `git push origin master` | 37 | 8. Push the commit with `git push origin master` |
| @@ -39,7 +39,7 @@ Since mat2 is written in Python3, please conform as much as possible to the | |||
| 39 | 10. Download the gitlab archive of the release | 39 | 10. Download the gitlab archive of the release |
| 40 | 11. Diff it against the local copy | 40 | 11. Diff it against the local copy |
| 41 | 12. If there is no difference, sign the archive with `gpg --armor --detach-sign mat2-$VERSION.tar.xz` | 41 | 12. If there is no difference, sign the archive with `gpg --armor --detach-sign mat2-$VERSION.tar.xz` |
| 42 | 13. Upload the signature on Gitlab's [tag page](https://0xacab.org/jvoisin/mat2/tags) and add the changelog there | 42 | 13. Upload the signature on Gitlab's [tag page](https://github.com/jvoisin/mat2/tags) and add the changelog there |
| 43 | 14. Announce the release on the [mailing list](https://mailman.boum.org/listinfo/mat-dev) | 43 | 14. Announce the release on the [mailing list](https://mailman.boum.org/listinfo/mat-dev) |
| 44 | 15. Sign'n'upload the new version on pypi with `python3 setup.py sdist bdist_wheel` then `twine upload -s dist/*` | 44 | 15. Sign'n'upload the new version on pypi with `python3 setup.py sdist bdist_wheel` then `twine upload -s dist/*` |
| 45 | 16. Do the secret release dance | 45 | 16. Do the secret release dance |