docs: update README and CONTRIBUTING to reflect hk and mise workflow #5
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
Updates the README and CONTRIBUTING documentation to reflect the new development workflow using
hk(git hooks) andmise(task runner/tool manager).Changes Made
README.md
mise installbuild,test,lint,ci, etc.)mise installand automated hook workflowCONTRIBUTING.md
Key Features
✅ Streamlined Setup: Single
mise installcommand sets up entire development environment✅ Automated Quality: Pre-commit hooks automatically format, lint, and test code
✅ Consistent Commands: Both
mise run <task>andhk <hook>available for flexibility✅ CI Parity: Local development uses same tools as CI pipeline
✅ Backward Compatibility: Manual setup instructions still available
Testing
mise.tomlhk.pklThe documentation now accurately reflects the modern development workflow while maintaining clarity for both new and existing contributors.
💻 View my work • About Codegen