diff options
| author | nicolargo <nicolas@nicolargo.com> | 2017-01-07 09:47:53 +0100 |
|---|---|---|
| committer | nicolargo <nicolas@nicolargo.com> | 2017-01-07 09:47:53 +0100 |
| commit | fa705e08e8b396dd6001bd93c5b3c2fc97e92b3a (patch) | |
| tree | 556a2780425a82320f9389f0bbb1f045655cfbf9 | |
| parent | b80ff98de32b5731b5e42aaecbfeb996f4d0890d (diff) | |
Update the CONTRIBUTING file
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 395e7fa9..df00fb9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ the preferred channel for [bug reports](#bug-reports), [features requests](#feat and [submitting pull requests](#pull-requests), but please respect the following restrictions: -* Please **do not** use the issue tracker for personal support requests. A official Q&A exist. [Use it](https://groups.google.com/forum/?hl=en#!forum/glances-users)! +* Please **do not** use the issue tracker for personal support requests. A official Q&A exist. [Use it](https://groups.google.com/forum/?hl=en#!forum/glances-users)! * Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. @@ -86,12 +86,13 @@ project's developers might not want to merge into the project. First of all, all pull request should be done on the `develop` branch. -Glances uses PEP8 compatible code, so use a PEP validator before submitting -your pull request. Also uses the unitaries tests scripts (unitest.py). +Glances uses PEP8 compatible code, so use a PEP validator before submitting +your pull request. Also uses the unitaries tests scripts (unitest-all.py). Similarly, when contributing to Glances's documentation, you should edit the documentation source files in -[the `/doc/` and `/man/` directories of the `develop` branch](https://github.com/nicolargo/glances/tree/develop/docs). +[the `/doc/` and `/man/` directories of the `develop` branch](https://github.com/nicolargo/glances/tree/develop/docs) and generate +the documentation outputs files by reading the [README](https://github.com/nicolargo/glances/tree/develop/docs/README.txt) file. Adhering to the following process is the best way to get your work included in the project: |