Repository navigation
docs: add a pull request template and tighten the comment rule - #2
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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.
Summary
Adds a pull request template and tightens the comment rule in CONTRIBUTING.md.
Why
Pull request descriptions had no fixed shape, and the code carried comments that described the task or the package behind a change instead of the code itself.
Changes
.github/pull_request_template.md: Summary, Why, Changes, Notes for reviewers, and a checklist built from the rules in CONTRIBUTING.md.CONTRIBUTING.md: pull requests use the template, in English. Comments are kept to a minimum and never name the task or package that prompted a change; that context goes in the pull request description.Notes for reviewers
None. Documentation only.
Checklist
developand is about one thingfeat(scope): ...,fix(scope): ...)src/frontend/src/app/core/models