docs: add pull request template - #28
Open
hasansezertasan wants to merge 1 commit into
Open
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a minimal, standardized pull request template under .github that enforces code of conduct & contribution guideline links and provides structured Description and Closes sections for new PRs. File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider replacing the literal '-' under the Description section with a brief HTML comment prompt (e.g., what details to include) so new PR authors aren’t tempted to leave the placeholder as-is.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider replacing the literal '-' under the Description section with a brief HTML comment prompt (e.g., what details to include) so new PR authors aren’t tempted to leave the placeholder as-is.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
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.
Description
Adds
.github/PULL_REQUEST_TEMPLATE.mdso new PRs are pre-populated with a consistent structure: Code of Conduct / contribution links, a Description section, and a Closes section for issue linking.Content adopted verbatim from #16 (the copier-based PR), matching the maintainers' latest intent. Note this template is intentionally minimal — the older checklist (coverage/docs/pre-commit/tests) was dropped in #16, and this PR preserves that decision.
Closes
Summary by Sourcery
Documentation:
.github/PULL_REQUEST_TEMPLATE.mddocumenting required description and issue-closing sections for new pull requests.