Rewrite documentation
Open
@kamari-a is already working on this.
Since May 27, 2023.
documentation
enhancement
hacktoberfest
help wanted
Priority:Low
- Dominant language
- C++
- Stars
- 729
- Forks
- 147
- Avg merge
- 19h
- Merged PRs (30d)
- 1
Description
At some point, we should rewrite/update the documentation (in both headers, and the README) to be grammatically correct English that is clear and concise.
This issue isn't meant to insult anyone's English, it's just meant to give the project a more professional polish, as I know many of the contributors here don't use English as a first language.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.