Skip to content

Commit c46367b

Browse files
authored
Added contributing guidelines
1 parent d09c418 commit c46367b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/user/contributing.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,19 @@ We are glad to know that you would like to contribute to the ``conda-forge`` doc
4848
your changes.
4949
5. Submit a `pull request
5050
<https://help.github.com/articles/about-pull-requests/>`_ to the main repository proposing your changes.
51+
52+
Writing guidelines:
53+
54+
Some basic writing guidelines should be kept in mind before you start contributing:
5155

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+
8. Avoid ambiguous titles. The title should include a clear description of the page's subject.
64+
9. Check your spellings and grammar.
5265
Happy contributing!
5366

0 commit comments

Comments
 (0)