docs: refresh CONTRIBUTING with the real dev workflow - #88
Closed
aryansk wants to merge 1 commit into
Closed
Conversation
Documents uv sync --extra dev setup, the exact commands CI runs (ruff, mypy, bandit, compileall, pytest), and end-to-end checklists for adding an agent tool or a slash command. Closes shauryagangrade#73.
4 tasks
shauryagangrade
approved these changes
Aug 15, 2026
shauryagangrade
left a comment
Owner
There was a problem hiding this comment.
Great refresh — this brings CONTRIBUTING in line with reality. I verified every command against the actual CI workflow (.github/workflows/ci.yml): uv sync --extra dev, ruff check ., ruff format --check ., mypy gcode, bandit -q -r gcode/ -c pyproject.toml, compileall gcode demo, pytest — all exact matches. The new tool/slash-command walkthroughs match the real code layout (gcode/tools.py, ALL_TOOLS, TOOL_MAP, _SLASH_COMMANDS, _print_help).
Notes (non-blocking):
- Cross-PR dependency: it links to
docs/windows.md, which only exists in #87 — merge #87 first. - The template references were updated to
.yml(bug_report.yml,feature_request.yml), which exist in.github/ISSUE_TEMPLATE/— correct. - Tiny nit: the PR checklist lines dropped their trailing periods ("documented (this checklist above)"); trivial formatting.
Approve — ready once you mark the PR ready for review.
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.
Problem
CONTRIBUTING.md describes
pip install -e .only and says nothing about theactual stack:
uvsync, ruff, mypy, bandit, the CI matrix, or how to add anew tool/slash command. New contributors can't validate their work locally
without reverse-engineering CI. Closes #73.
Change
Rewrites CONTRIBUTING.md to match the real dev workflow:
uv sync --extra devsetup with a pointer to the Windows guide.ruff check,ruff format --check,mypy gcode,bandit,compileall,pytest) and the Python3.10–3.13 matrix note.
gcode/tools.py,ALL_TOOLS,TOOL_MAP, tests) and one for adding a slash command(
gcode/cli.pyhandler,_SLASH_COMMANDSingcode/ui.py,_print_help, README Commands list, tests).bug_report.yml,feature_request.yml).Why this approach
Docs-only, no behavior change. The checklists were verified against the
current source (tools.py, ui.py, cli.py, ci.yml) so a newcomer can go from
clone to green local checks using the doc alone.
Testing
git diff --checkclean.(README
#setup/#use,.github/ISSUE_TEMPLATE/*.yml,docs/windows.md)..github/workflows/ci.ymlexactly.Documentation and release impact
Review notes
(adds a Pre-commit Hooks section); this PR fully rewrites the file. If both
merge, a small rebase on CONTRIBUTING.md is needed — happy to do it.