arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2026-08-20 07:17:26 +00:00
Code Issues Projects Releases Wiki Activity

docs: update contributing guide

Browse Source
This commit is contained in:
arcanis
2026-08-18 15:13:41 +03:00
parent 25ecefab83
commit cd374dfbdf
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+7 -1
View File
@@ -247,13 +247,19 @@ tox -e docs
Must be usually done if there are changes in modules structure.
### Before making a new release
1. Make sure that all pipelines are green.
2. Make sure that documentation is up-to-date.
3. Run [regress job](https://github.com/arcan1s/ahriman/actions/workflows/regress.yml). The successful link must be attached to release.
### Create release
```shell
tox -m release -- major.minor.patch
```
The command above will generate documentation, tags, etc., and will push them to GitHub. Other things will be handled by GitHub workflows automatically.
The command above will generate documentation, tags, etc., and will push them to GitHub. Other things will be handled by GitHub workflows automatically. As soon as related github action completes, there will be a new release created. Edit it to add additional information if needed.
### Hotfixes policy