Extended Description for the Pull Request #11526
Open
+108
−163
Conversation
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
Summary of Changes This PR proposes several non-policy changes to the CONTRIBUTING.md file aimed at improving clarity, scannability, and tone, especially for new open-source contributors. The goal is to make the contribution process feel more welcoming and straightforward. Specific Improvements Improved Formatting: Added clearer hierarchy using updated Markdown headings (##, ###) and judicious bolding of key terms (like labels: good first issue, status: accepting pr) to help guide the reader's eye. Enhanced Readability: Broke up dense paragraphs, primarily in the "Get Involved" and "Pull Requests" sections, into more digestible bulleted lists for better scannability. Action-Oriented Language: Revised some headings and introductory text to use a more direct and active voice (e.g., from "Our Development Process" to "Our Development Process"). Code Conventions: Restructured the "Code Conventions" section to emphasize the "Look around" rule and clarify the role of Prettier and ESLint. Versioned Docs Clarity: Made the distinction between the website/docs (next version) and website/versioned_docs (released versions) more explicit for documentation contributors. These changes are purely textual and do not alter any established Docusaurus contribution policies, required steps, or technical information.
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
This PR proposes several non-policy changes to the CONTRIBUTING.md file aimed at improving clarity, scannability, and tone, especially for new open-source contributors. The goal is to make the contribution process feel more welcoming and straightforward.
Specific Improvements
Improved Formatting: Added clearer hierarchy using updated Markdown headings (##, ###) and judicious bolding of key terms (like labels: good first issue, status: accepting pr) to help guide the reader's eye.
Enhanced Readability: Broke up dense paragraphs, primarily in the "Get Involved" and "Pull Requests" sections, into more digestible bulleted lists for better scannability.
Action-Oriented Language: Revised some headings and introductory text to use a more direct and active voice (e.g., from "Our Development Process" to "Our Development Process").
Code Conventions: Restructured the "Code Conventions" section to emphasize the "Look around" rule and clarify the role of Prettier and ESLint.
Versioned Docs Clarity: Made the distinction between the website/docs (next version) and website/versioned_docs (released versions) more explicit for documentation contributors.
These changes are purely textual and do not alter any established Docusaurus contribution policies, required steps, or technical information.