Make the devdocs more complete and self-contained (#252)

* Make the devdocs more complete and self-contained

* Rename devdocs/misc-notes-from-contributors.md to devdocs/misc/misc_notes_for_committers.md

* Document the dependencies of the build script

* No need to manually make multiple commits

---------

Co-authored-by: Ian Butterworth <i.r.butterworth@gmail.com>
This commit is contained in:
Dilum Aluthge
2024-06-26 14:18:44 -04:00
committed by GitHub
parent 389de5c0df
commit cae3c21ea1
6 changed files with 190 additions and 12 deletions

View File

@@ -1,11 +1,3 @@
# Dev docs / Contributing guide
# Contributing
## Building and tagging a release (requires write access)
1. Test your changes, merge into `master`.
2. Checkout `master`.
3. Bump the version number in [`package.json`](package.json).
4. Run `./bin/build-release julia-actions/setup-julia` to create a release branch and build a release.
5. Push the branch (**without tags**) and verify that CI is passing on it.
6. Run `git push --tags --force` to update the tags.
7. Create a release for the `vX.Y.Z` tag.
Please see the README in the [`devdocs/`](devdocs/) folder.