docs: add PR etiquette guidelines and improve contribution templates - #722
Open
Aditya Shantanu (aditya-shantanu) wants to merge 1 commit into
Open
Conversation
Adds a PR Etiquette section to README.md making it explicit that: - contributors must file an issue with repro steps before sending a PR - PRs with no linked issue will not be reviewed Strengthens the PR template to surface the issue-first requirement prominently, and improves the bug report template with structured fields (environment, logs block, minimal repro) to raise report quality.
Aditya Shantanu (aditya-shantanu)
marked this pull request as ready for review
August 4, 2026 03:07
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.
Summary
README.mdmaking the issue-first requirement explicit: contributors must file an issue with clear repro steps before opening a PR, and PRs with no linked issue will not be reviewed..github/PULL_REQUEST_TEMPLATE.mdwith a prominent stop-sign notice, a "What changed and why" section, and a checklist that requires an issue link..github/ISSUE_TEMPLATE/bug_report.mdwith structured fields (environment, expected/actual behavior, steps to reproduce, collapsible logs block, minimal repro) to raise the quality of incoming reports.Motivation
Unanchored PRs cost maintainer time and contributor goodwill. Requiring an issue first lets us confirm the problem, align on the fix, and avoid duplicating in-flight work — before anyone writes code.
Test plan