docs: document the issue-first contribution workflow (#6)#8
Merged
Conversation
Our issue-first workflow wasn't written down anywhere, so contributors couldn't follow conventions they couldn't see. Document it and fix the contribution docs that drifted from reality. CONTRIBUTING.md: - add an "Issue-First Workflow" section: start from an issue, branch `feature/<issue-number>_<short_snake_case>`, commit `#<num> <type>: ...`, PR to `main` with `Closes #<num>`, plus a note on stacked branches; - rework the Commit Message Guidelines around the `#<num>` prefix. README.md: - Development Setup: `libclang-18` -> `libclang-dev` (matches CI and CONTRIBUTING), add `rustc` and `uv sync --all-extras`; - Contributing / PR Guidelines now point to the issue-first workflow; - Plugin Architecture: move Rust from "Planned" to implemented; - fix stale Poetry-style snippets (`[tool.poetry.*]`) to the PEP 621 forms the project actually uses (`[project.optional-dependencies]`, `[project.entry-points."prepkit.*"]`). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.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
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.
Closes #6.
Why
The issue-first workflow we follow (issue →
feature/N_descbranch →#Ncommits →Closes #N) wasn't documented anywhere, and the contribution docs had drifted from the actual project setup..github/CONTRIBUTING.mdfeature/<issue-number>_<short_snake_case>, commit#<num> <type>: ..., open a PR tomainwithCloses #<num>, plus a note on stacked branches.#<num>subject prefix, with real examples.README.md(accuracy fixes found during the doc audit)libclang-18→libclang-dev(matches CI + CONTRIBUTING); addedrustcanduv sync --all-extras.[tool.poetry.*]) to the PEP 621 forms the project actually uses ([project.optional-dependencies],[project.entry-points."prepkit.*"]).Docs-only change; no code touched.
🤖 Generated with Claude Code