chore: enforce issue, PR, and branch conventions - #3
Merged
Conversation
Convert issue templates to YAML forms with required fields and disable blank issues, so reports carry the needed context. Add a PR-conventions check that fails any pull request whose branch name or title does not follow <type>/<desc> and Conventional Commits. Document the convention in CONTRIBUTING and remind contributors in the PR template.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Tightens repo hygiene so issues, PRs, and branches stay consistent and enforceable.
Issues (now enforced, not just suggested)
bug_report.yml/feature_request.yml: YAML forms with required fields, so reports cannot be submitted empty.config.yml:blank_issues_enabled: false(forces a template) plus contact links to the docs and private security reporting..mdtemplates they replace.Pull requests and branches (CI-enforced)
pr-conventions.yml: fails any PR whose branch is not<type>/<short-desc>or whose title is not Conventional Commits. Plain shell, no external actions; skipsdependabot/andrevert-branches.feat, fix, docs, ci, chore, refactor, test, perf, build, style, revert.Closes #.Docs
The regex was tested locally against valid and invalid samples. Note: the check starts enforcing on PRs opened after this merges (this PR predates it on
main).Recommend turning on branch protection for
mainand markingPR conventions(andCI) as required status checks so the rules cannot be bypassed.