-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Description
Motivation
The current Contributing Guidelines contain minor grammatical inconsistencies and sentence structure issues that may slightly affect readability and professionalism.
This feature request aims to improve the clarity, flow, and grammatical accuracy of the document, ensuring it aligns with the overall quality of the repository’s documentation.
Examples
Here are a few examples of proposed grammatical improvements:
Original: “Before sending your pull requests, make sure that you read the whole guidelines.”
Revised: “Before sending your pull requests, make sure you read the entire set of guidelines.”
Original: “We are very happy that you consider implementing algorithms and data structures for others!”
Revised: “We are very happy that you are considering implementing algorithms and data structures for others!”
Original: “If you submit a pull request that resolves an open issue, please help us to keep our issue list small...”
Revised: “If you submit a pull request that resolves an open issue, please help us keep our issue list small...”
These changes make the document sound more natural while maintaining its meaning and intent.
Possible workarounds
There are no functional workarounds required, as this change only involves editing documentation for improved readability and consistency.
Additional information
This PR focuses solely on grammatical corrections and language consistency.
No structural, functional, or formatting changes have been made to the original content.
All modifications comply with the project’s contribution and commit guidelines.