Add description of release process to developer doc #46
Conversation
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
With the link anchors on separate lines before section headings, I found it hard to view and edit the file in an editor. I moved them into the heading lines, as is done in Stim's documentation; I find this more readable and easier to edit. This commit also contains miscellaneous trivial edits to make capitalization more consistent and fix a couple of typos.
These are mostly copied from Stim's developer documentation.
mhucka
added
documentation
Strilanc
approved these changes
Nov 19, 2025
mhucka
added a commit
that referenced
this pull request
Dec 1, 2025
This adds a section to `doc/developers.md` about making releases of Chromobius. Much of the text is taken from Stim's developer documentation. In addition, this changes the capitalization of some names to make things more consistent overall, and fixes a couple of typos. Lastly, it also slightly changes how headings are written in `doc/developers.md`. The way the link anchors were before, on separate lines before section headings, I found it hard to view and edit this file in an editor. By contrast, the approach in the Stim documentation was easier and more readable (IMHO), so I followed the same pattern here. I moved the link anchors into the heading lines.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 adds a section to
doc/developers.mdabout making releases of Chromobius. Much of the text is taken from Stim's developer documentation.In addition, this changes the capitalization of some names to make things more consistent overall, and fixes a couple of typos.
Lastly, it also slightly changes how headings are written in
doc/developers.md. The way the link anchors were before, on separate lines before section headings, I found it hard to view and edit this file in an editor. By contrast, the approach in the Stim documentation was easier and more readable (IMHO), so I followed the same pattern here. I moved the link anchors into the heading lines.