Expose contributing guide to GitHub - #1245
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 684fec44-989a-4d0e-a42b-79efbda28933
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes the repository’s contributing guide naming and presentation so GitHub can detect it for the community profile and contribution surfaces.
Changes:
- Updates the README “Contributions” link to point to
docs/CONTRIBUTING.md. - Adjusts the contributing guide’s top-level heading to “Contributing”.
Show a summary per file
| File | Description |
|---|---|
| README.md | Fixes the contributor guide link to the standardized docs/CONTRIBUTING.md path. |
| docs/CONTRIBUTING.md | Updates the document heading to reflect a standard “Contributing” title. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
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:
GitHub does not recognize the existing contributor guide because its filename is non-standard. Rename it to
docs/CONTRIBUTING.md, update its heading, and adjust the README link so the guide appears in the repository community profile and contribution surfaces.Related issue:
N/A
Check list:
npm run checklocally (format, lint, build, test) and all checks pass.