summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorjvoisin2025-09-03 16:18:52 +0200
committerjvoisin2025-09-04 14:35:36 +0200
commit102f08cd2807e0e664064f118a66b0c974c43c0e (patch)
tree28ef3e2048af11fd0d43971ba4a1681971dfbf16 /CONTRIBUTING.md
parent7a8ea224bc327b8ee929379d577c74968ea1c352 (diff)
Switch the project from 0xacab to github
While the folks running 0xacab are much more lovely than the github ones, this project has outgrown the former: - Github offers beefy continuous integration, make it easier to run the testsuite on every python version, instead of using a weird docker-based contraption. Moreover, I'd rather burn some Microsoft money than 0xacab one. - Opening an account on 0xacab is non-trivial (by design), making it tedious for people to report issues and contribute to mat2. - Gitlab is becoming unbearably slow and convoluted, even compared to Github's awful Copilot/AI push. It's a sad state of affairs, but it's a pragmatic decision. People who don't have a Github account can still report issues and send patches by sending me an email.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
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
3The main repository for mat2 is on [0xacab]( https://0xacab.org/jvoisin/mat2 ), 3The main repository for mat2 is on [github]( https://github.com/jvoisin/mat2 ),
4but you can send patches to jvoisin by [email](https://dustri.org/) if you prefer. 4but you can send patches to jvoisin by [email](https://dustri.org/) if you prefer.
5 5
6Do feel free to pick up [an issue]( https://0xacab.org/jvoisin/mat2/issues ) 6Do feel free to pick up [an issue]( https://github.com/jvoisin/mat2/issues )
7and to send a pull-request. 7and to send a pull-request.
8 8
9Before sending the pull-request, please do check that everything is fine by 9Before 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
301. Update the [changelog](https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md) 301. Update the [changelog](https://github.com/jvoisin/mat2/blob/master/CHANGELOG.md)
312. Update the version in the [mat2](https://0xacab.org/jvoisin/mat2/blob/master/mat2) file 312. Update the version in the [mat2](https://github.com/jvoisin/mat2/blob/master/mat2) file
323. Update the version in the [setup.py](https://0xacab.org/jvoisin/mat2/blob/master/setup.py) file 323. Update the version in the [setup.py](https://github.com/jvoisin/mat2/blob/master/setup.py) file
334. Update the version in the [pyproject.toml](https://0xacab.org/jvoisin/mat2/blob/master/yproject.toml) file 334. Update the version in the [pyproject.toml](https://github.com/jvoisin/mat2/blob/master/yproject.toml) file
345. Update the version and date in the [man page](https://0xacab.org/jvoisin/mat2/blob/master/doc/mat2.1) 345. Update the version and date in the [man page](https://github.com/jvoisin/mat2/blob/master/doc/mat2.1)
356. Commit the modified files 356. Commit the modified files
367. Create a tag with `git tag -s $VERSION` 367. Create a tag with `git tag -s $VERSION`
378. Push the commit with `git push origin master` 378. 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
3910. Download the gitlab archive of the release 3910. Download the gitlab archive of the release
4011. Diff it against the local copy 4011. Diff it against the local copy
4112. If there is no difference, sign the archive with `gpg --armor --detach-sign mat2-$VERSION.tar.xz` 4112. If there is no difference, sign the archive with `gpg --armor --detach-sign mat2-$VERSION.tar.xz`
4213. Upload the signature on Gitlab's [tag page](https://0xacab.org/jvoisin/mat2/tags) and add the changelog there 4213. Upload the signature on Gitlab's [tag page](https://github.com/jvoisin/mat2/tags) and add the changelog there
4314. Announce the release on the [mailing list](https://mailman.boum.org/listinfo/mat-dev) 4314. Announce the release on the [mailing list](https://mailman.boum.org/listinfo/mat-dev)
4415. Sign'n'upload the new version on pypi with `python3 setup.py sdist bdist_wheel` then `twine upload -s dist/*` 4415. Sign'n'upload the new version on pypi with `python3 setup.py sdist bdist_wheel` then `twine upload -s dist/*`
4516. Do the secret release dance 4516. Do the secret release dance