File tree Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Original file line number Diff line number Diff line change @@ -48,6 +48,19 @@ We are glad to know that you would like to contribute to the ``conda-forge`` doc
48
48
your changes.
49
49
5. Submit a `pull request
50
50
<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:
51
55
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.
52
65
Happy contributing!
53
66
You can’t perform that action at this time.
0 commit comments