Skip to content

Commit 9f1d7ee

Browse files
author
Uma
committed
Improved the grammar and added more points
1 parent 130968e commit 9f1d7ee

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

src/user/contributing.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,20 @@ We are glad to know that you would like to contribute to the ``conda-forge`` doc
4949
5. Submit a `pull request
5050
<https://help.github.com/articles/about-pull-requests/>`_ to the main repository proposing your changes.
5151

52+
5253
Writing guidelines:
53-
1. Identify your audience and Understand their skill level.
54-
2. Match the technical language with to the audience's skill level proficiency.
55-
3. Try to Keep it simple.Incase,if you have to use a lot of complicated terms provide a glossary of key terms
56-
4. Address the audience directly as user(s).
57-
5. While mentioning about an action, use the "command" form of the verb: "Choose an option from the menu and press Enter."
58-
6. For reference,Provide links to related content.
54+
55+
Some basic writing guidelines should be kept in mind before you start contributing.
56+
1. Identify your audience and understand their skill level.
57+
2. Match the technical language with the audience's skill level proficiency.
58+
3. Try to Keep it simple. In case you have to use a lot of complicated terms, provide a glossary of key terms.
59+
4. Address the audience directly as the user(s).
60+
5. While mentioning an action, use the “command” form of the verb: “Choose an option from the menu and press Enter.”
61+
6. For references, provide links to related content.
62+
7. Use headings and bullet points which makes it easier to read.
63+
7. Avoid ambiguous titles. The title should include a clear description of the page's subject.
64+
8. Check your spelling and grammar.
65+
5966

6067
Happy contributing!
68+

0 commit comments

Comments
 (0)