Documentation - CONTRIBUTING.md - Improvement. #554
Description
Hello,
I believe the sections under the Contributing.md document can be improved.
Here are a few suggestions -
- Linking - While reading, a person may want to jump directly to the repository and sites that have been mentioned but would have to browse which may get a little annoying.
- Reducing the use of Passive voice and Indirect speech - The vast majority of sentences in technical writing are usually in active voice and direct speech.
For example:
This:
If you are unsure if your change will be accepted or if want to discuss the approach before diving in, please create an issue and pose questions
Can be said as:
If you are not sure whether your changes will be accepted or want to discuss the method before delving into it, please create an issue and ask it.
Not a lot of differences but clearer sentences can lead to better communication.
- Just a little neatening up of the document such as capitalization here and there.
PS:
I) I realize that this is not a lot but I believe can be helpful.
2) The Code of Conduct section and Architecture section - I don't know if these sections have been touched upon, as I am very new here, but if not I would like to help with it.