suzanne.soy/qubes-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create "Contribution Suggestions" section

Browse Source
This commit is contained in:
Andrew David Wong 2017-01-23 04:29:55 -08:00
parent aa69a06c3c
commit 4947dd1a2f
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
basics_dev/doc-guidelines.md
View File

@ -106,6 +106,26 @@ pull request, we'll post a comment explaining why we can't.
![done](/attachment/wiki/doc-edit/10-done.png) ![done](/attachment/wiki/doc-edit/10-done.png)
Contribution Suggestions
------------------------
* If you find any inaccuracies in the documentation, please correct them!
* If you find an inaccuracy but don't know how to correct, you can still help
by documenting the inaccuracy. For example, if you have *thoroughly* tested
a set of steps in the documentation and know *for certain* that they no
longer work on a certain version of Qubes (e.g., because the steps are
out-of-date), then please add a note to the documentation indicating this.
You may also wish to provide a link to a relevant thread on the [mailing
lists].
* Where appropriate, specify the version of the software to which your
contribution applies. For example, if you're contributing a set of
instructions for doing something in dom0, specify the version(s) of Qubes OS
with which you know these instructions to work. This allows future readers to
more easily estimate the accuracy and applicability of information.
Style Guidelines Style Guidelines
---------------- ----------------
@ -153,5 +173,6 @@ Please try to write good commit messages, according to the
[gh-fork]: https://guides.github.com/activities/forking/ [gh-fork]: https://guides.github.com/activities/forking/
[gh-pull]: https://help.github.com/articles/using-pull-requests/ [gh-pull]: https://help.github.com/articles/using-pull-requests/
[GitHub]: https://github.com/ [GitHub]: https://github.com/
[mailing lists]: /mailing-lists/
[md]: https://daringfireball.net/projects/markdown/ [md]: https://daringfireball.net/projects/markdown/
[git-commit]: /doc/coding-style/#commit-message-guidelines [git-commit]: /doc/coding-style/#commit-message-guidelines