Skip to content

Conversation

@codegen-sh
Copy link
Contributor

@codegen-sh codegen-sh bot commented Jun 22, 2025

Summary

Updates the README and CONTRIBUTING documentation to reflect the new development workflow using hk (git hooks) and mise (task runner/tool manager).

Changes Made

README.md

  • Development Section: Added mise as the recommended setup method with mise install
  • Available Tasks: Documented all mise tasks (build, test, lint, ci, etc.)
  • Git Hooks: Added section explaining hk pre-commit hooks and available commands
  • Testing Instructions: Updated to show mise/hk commands alongside traditional cargo commands
  • Quick Contributing: Updated steps to include mise install and automated hook workflow
  • Development Guidelines: Mentioned automated pre-commit checks

CONTRIBUTING.md

  • Development Setup: Made mise the primary setup method with comprehensive tool installation
  • Tool Overview: Added new section explaining mise and hk integration
  • Automated Quality Checks: Documented all pre-commit hooks (fmt, clippy, test, typos, prettier, deny)
  • Testing Section: Updated commands to use mise/hk alongside traditional methods
  • Pre-submission Checklist: Modernized to reflect automated hooks while maintaining manual verification steps
  • Tool Integration: Explained how mise and hk work together

Key Features

Streamlined Setup: Single mise install command sets up entire development environment
Automated Quality: Pre-commit hooks automatically format, lint, and test code
Consistent Commands: Both mise run <task> and hk <hook> available for flexibility
CI Parity: Local development uses same tools as CI pipeline
Backward Compatibility: Manual setup instructions still available

Testing

  • Verified all documented commands work correctly
  • Confirmed mise tasks match actual configuration in mise.toml
  • Validated hk hooks match configuration in hk.pkl
  • Ensured documentation reflects actual CI workflow

The documentation now accurately reflects the modern development workflow while maintaining clarity for both new and existing contributors.


💻 View my workAbout Codegen

- Add mise as recommended task runner and tool manager
- Document hk git hooks for automated code quality checks
- Update development setup instructions to use mise install
- Add comprehensive tool workflow documentation
- Update testing instructions to use mise/hk commands
- Modernize pre-submission checklist to reflect automated hooks
- Add quick reference for available mise tasks and hk hooks
- Maintain backward compatibility with manual setup instructions
@codecov-commenter
Copy link

codecov-commenter commented Jun 22, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

Welcome to Codecov! ☔️

💻 View my work

@bashandbone bashandbone merged commit 4d7823c into main Jun 22, 2025
7 checks passed
@bashandbone bashandbone deleted the codegen-bot/update-docs-hk-mise-workflow-a8f9d2 branch June 22, 2025 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants