Skip to content

Improve punctuation and readability in CONTRIBUTING.md #13135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve punctuation and readability in CONTRIBUTING.md #13135

wants to merge 1 commit into from

Conversation

RohitKattimani
Copy link

Describe your change:

This PR fixes minor punctuation and readability issues in CONTRIBUTING.md to make the text clearer and easier to follow.

  • Added commas for better sentence flow (e.g., after introductory clauses and before conjunctions)
  • Corrected hyphenation for compound words (e.g., "single-letter variable names")
  • Improved spacing around periods and inline code
  • Fixed minor grammar inconsistencies without changing meaning

These changes are purely editorial and do not affect any code or instructions.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@RohitKattimani
Improve punctuation and readability in CONTRIBUTING.md
3d16a0a 
This PR fixes minor punctuation and readability issues in CONTRIBUTING.md to make the text clearer and easier to follow.  

- Added commas for better sentence flow (e.g., after introductory clauses and before conjunctions)
- Corrected hyphenation for compound words (e.g., "single-letter variable names")
- Improved spacing around periods and inline code
- Fixed minor grammar inconsistencies without changing meaning

These changes are purely editorial and do not affect any code or instructions.
@algorithms-keeper algorithms-keeper bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Oct 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@RohitKattimani