docs: add CONTRIBUTING.md documenting the 'Client PR: #N' marker workflow#77
Merged
Merged
Conversation
…arker
The README's Contributing section was a stub. Move it into a proper
CONTRIBUTING.md (GitHub auto-detects this filename and surfaces it on
new-issue / new-PR pages) and expand it with the cross-repo workflow:
- The 'Client PR: #N' marker convention (and the cross-repo /
fork form 'Client PR: 0xMiden/miden-client#N')
- What CI does with the marker (auto-patch action, sticky PR
comment, readiness gate)
- Branch-protection guidance (require linked-client-pr-ready, NOT
the gate matrix job)
- Local-dev parity (scripts/dev-with-client-pr.sh)
- The three situations where you still want to hand-edit
Cargo.toml instead of using the marker
README's Contributing section is now a one-line pointer.
WiktorStarczewski
added
the
no changelog
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
1 participant
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.
Move README's Contributing section into a proper CONTRIBUTING.md and expand it with the cross-repo workflow that landed in #65/#66 (auto-patch + sticky comment + readiness gate). Also documents local-dev parity (scripts/dev-with-client-pr.sh) and the three situations where you still want to hand-edit Cargo.toml instead of using the marker.
README's Contributing section is now a one-line pointer.