This file is a placeholder for projects created from Blueprint. Replace it with real contribution guidance for your repository.
- Replace this title with
Contributing to <Project>. - Point contributors to
docs/README.mdand the project issue tracker. - Record the default branch, PR title conventions, and required checks (
bash scripts/flake.bash --ci,bash scripts/test.bash, and so on). - Describe how to run
bash scripts/rename.bashif the repo is still being turned into a downstream project. - Remove template-only notes that do not apply to the real project.
While Blueprint remains the upstream template:
- Use the standard issue templates (
Bug Report,Feature Request,Documentation,Question) like any downstream project should. - Keep changes focused; match existing script and docs conventions.
- Run
bash scripts/sync-env.bash --check,bash scripts/flake.bash --ci, andbash scripts/test.bashbefore opening a pull request. - Do not commit secrets, local
.venvpaths, or machine-specific overrides.
Use the pull request template in .github/pull_request_template.md.
For template work, describe whether the change affects downstream projects created with Use this template or only Blueprint maintenance.