Repository navigation
Adopt an issues-first contribution policy - #212
Merged
Merged
Conversation
Add a pull-request template that asks contributors to open an issue first, a CONTRIBUTING guide explaining why, bug and feature issue templates, and a short README pointer. Generating a pull request is cheap, but verifying one against the frozen legacy output contract is not, and that cost falls on the maintainer. Pull requests are now reviewed only after an issue has been opened and the change agreed there; security fixes excepted. Docs and templates only. No library behavior changes, no release.
|
coverage: 99.701%. remained the same — chore/issues-first into master |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Maintainer change. Since September this repo has had 14 external pull requests against 2 issues, and verifying each one against the frozen legacy output is the expensive part. Generating a pull request is cheap; checking it is not, and that cost lands on the maintainer.
This makes the project issues first:
.github/pull_request_template.md— the first thing anyone sees when opening a pull request. It says open an issue instead, and that a pull request with no linked, agreed issue will be closed with thanks. It includes a checkbox for "neither — I should close this and open an issue instead."CONTRIBUTING.md— the policy and the reasoning, what makes an issue easy to act on, and the rules for an agreed pull request (frozen legacy, modern opt-in, checks)..github/ISSUE_TEMPLATE/— bug report and feature request forms that ask for a runnable example, versions, backend, and algorithm, plus a chooser link to the contributing guide.README.md— a short "Bugs and ideas" section pointing at issues.AGENTS.md— the same rule recorded for agent maintainers.GitHub can't disable pull requests outright, so this is enforced by policy: unsolicited pull requests get closed gently, with an invitation to file an issue. Security fixes are the exception. Real users with real problems are still welcome — that's what issues are for.
Docs and templates only. All 133 tests pass,
git diff --checkis clean, issue-template YAML validates. No library behavior changes, so no release.🚀 Generated with Dojo ⛩️