Submitting Changes
Before You Start
- Check existing issues for related work
- For large changes, open an issue first to discuss approach
- Fork the repository
Development Workflow
-
Create a feature branch:
git checkout -b feat/my-feature -
Make your changes
-
Test thoroughly:
tk test //... nix flake check -
Commit with conventional message:
git commit -m "feat: add zig toolchain support"
Pull Request Process
-
Push your branch:
git push -u origin feat/my-feature -
Open a Pull Request on GitHub
-
Fill out the PR template:
- Summary of changes
- Test plan
- Related issues
-
Wait for review
PR Checklist
-
Tests pass (
tk test //...) -
Nix flake checks pass (
nix flake check) - Pre-commit hooks pass
- Documentation updated if needed
- Commit messages follow convention
Review Process
- Maintainers will review within a few days
- Address feedback with additional commits
- Once approved, maintainer will merge
After Merge
- Delete your feature branch
- Pull latest main
- Thanks for contributing!
Getting Help
- Open an issue for questions
- Tag maintainers if stuck on review
- Check existing PRs for examples