Add comprehensive release process documentation#60
Merged
Conversation
Collaborator
|
Looks fine to me, but the proof of the pudding is in going through the steps as if you didn't know what you were doing and seeing that everything works. Also in #61 you propose to change the way that this works, so do you want to wait until that is done and update this documentation? |
Member
Author
|
Thanks! And that is exactly what I am doing right now. If it all works I'll push my updates to this branch. I have some already, so don't merge until it is all there |
Member
Author
AaronDJohnson
approved these changes
Oct 24, 2025
Collaborator
AaronDJohnson
left a comment
There was a problem hiding this comment.
Looks good to me.
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.
Summary
This PR adds detailed documentation for the PTMCMCSampler release process, which was previously undocumented and relied on institutional knowledge.
Changes Made
RELEASE.md: Comprehensive release documentation including:setuptools_scmversion managementREADME.md: Added "For Maintainers" section with link to release documentationRelease Process Documented
setuptools_scm(automatic from git tags)Benefits