Cleans up and clarifies gitignore contribution guidelines#4843
Merged
Conversation
Adds clarification around our expectations for contributions and how contributions will be handled when they don't meet our requirements. Updates template to lean into our contribution guidelines. Cleans up duplicate wording around our contribution guidelines.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s contribution documentation to reduce duplication, clarify expectations for .gitignore template submissions, and align the PR template with the contribution process.
Changes:
- Adds a prominent pointer in
README.mdto the contribution guidelines and replaces duplicated inline guidelines with a link. - Clarifies and expands the rules in
CONTRIBUTING.md(scope, duplicates, section placement, and closure expectations). - Updates
.github/PULL_REQUEST_TEMPLATE.mdto prompt for required contribution metadata and reinforce guideline compliance.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds an early reference to the guidelines and replaces the full “Contributing guidelines” block with a link to CONTRIBUTING.md. |
| CONTRIBUTING.md | Expands/clarifies contribution requirements (scope, duplication, placement) and adds language about closing non-compliant PRs. |
| .github/PULL_REQUEST_TEMPLATE.md | Adds a homepage link section and tightens the checklist messaging around meeting guidelines. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 4
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
dooleydevin
previously approved these changes
Apr 17, 2026
Removed the checklist item for ensuring CI is passing. We don't really have CI as of yet and it's confusing to list that requirement. If we do add CI, we'll make it required instead of adding it to the template checklist.
dooleydevin
approved these changes
Apr 17, 2026
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.
Reasons for making this change
Adds clarification around our expectations for contributions and how contributions will be handled when they don't meet our requirements.
Updates template to lean into our contribution guidelines.
Cleans up duplicate wording around our contribution guidelines.
Links to documentation supporting these rule changes
NA
If this is a new template
Link to application or project’s homepage: github.com/github/gitignore 😄
Merge and Approval Steps