Skip to content

📝 docs: require tests for features and bug fixes #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gaborbernat merged 1 commit into from
Nov 5, 2026
Merged

📝 docs: require tests for features and bug fixes #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Contributing

Open a pull request for changes to the Action. The CI workflow runs the Action in a checkout with a Python project, a
checkout without one, and a checkout where uv is already installed.
Open a pull request for changes to the Action. Run `prek run --all-files` before pushing changes.

## Release notes

Expand All @@ -23,3 +22,12 @@ pending fragment categories. The workflow calculates a `v`-prefixed tag, builds
`release-creator contributors` to list first-time contributors from the commit authors and co-authors, runs `prek`, and
validates the patch before a repository-scoped GitHub App pushes the release commit and tag. The tag workflow creates a
GitHub Release from the tagged changelog and advances the floating `v1` and `v1.0` tags when appropriate.

## Tests

Add a test for every new feature and bug fix. A change without a test needs a reason in the pull request description.

The tests are the self-test jobs of the CI workflow in `.github/workflows/main.yml`. Each job runs the Action from the
pull request in a different setup: a directory with a Python project, a directory without one, and a runner where uv is
already installed. Cover a new input or code path with a new job or a new step in an existing one. The jobs run on every
pull request and on pushes to `main` and to branches named `test-me-*`.