DOC: Add contribution guidlines for versioning and releasing - #83
Merged
Conversation
Documentation build overview
9 files changed ·
|
mberz
force-pushed
the
docs/contribution_versioning
branch
2 times, most recently
from
September 2, 2026 10:04
56476a6 to
d5e3014
Compare
mberz
force-pushed
the
docs/contribution_versioning
branch
from
September 2, 2026 10:09
d5e3014 to
257d77a
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The new documentation contains several verified typos/grammar issues that should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR expands the contributor documentation to cover release/versioning workflows across CHORAS components (backend, simulation methods, frontend) and adds a frontend development environment quickstart, plus umbrella-repo guidance for bumping the combined CHORAS version when submodules are updated.
Changes:
- Add new release workflow guides for backend, simulation-backend (per-method and umbrella), and frontend.
- Add a frontend development setup quickstart document.
- Extend general release guidelines with step-by-step instructions for bumping the combined CHORAS version and update the docs toctree accordingly.
File summaries
| File | Description |
|---|---|
| docs/source/includes/contributing/simulation_method/releasing.rst | New simulation-backend release guide covering per-method vs umbrella releases. |
| docs/source/includes/contributing/general/releasing.rst | Adds combined CHORAS version bump procedure for umbrella repo submodule updates. |
| docs/source/includes/contributing/frontend/setup_dev.rst | New frontend development environment setup/quickstart instructions. |
| docs/source/includes/contributing/frontend/releasing.rst | New frontend release process (standard-version + Conventional Commits). |
| docs/source/includes/contributing/backend/releasing.rst | New backend release workflow doc (bump-my-version + tagging/pushing). |
| docs/source/includes/contributing.rst | Adds the new backend/simulation/frontend docs to the navigation toctree. |
Review details
Suppressed comments (1)
docs/source/includes/contributing/backend/releasing.rst:21
- Sentence is missing a terminating period, which reads like an accidental truncation.
For more information on the versioning scheme, please refer to the `versioning section <../general/releasing.html#versioning>`_ in the general contributing guidelines
- Files reviewed: 6/6 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds documentation on the release and development workflow documentation for all components of the project. It introduces guides for releasing the backend, simulation methods, and frontend, as well as instructions for setting up the frontend development environment.
Additionally, it updates the general release guidelines of the umbrella repository when submodules are updated.
Release workflow documentation:
releasing.rstguides for the backend, simulation methods, and frontend, each detailing their respective versioning strategies, release commands, and post-release steps.Frontend development setup:
setup_dev.rstfor the frontend, explaining how to fork, clone, set up submodules, and start the development server.