summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2021-07-04 15:46:29 +0200
committernicolargo <nicolas@nicolargo.com>2021-07-04 15:46:29 +0200
commit3739e057dfb6d4aeaefeffb90bb2b3fd5ee2b03f (patch)
tree60b5c046049a19dbc372c4cc307df68c4fa37ef6
parente3fab78968f849738a8f66a06a956d7c43c19467 (diff)
Update contribution file
-rw-r--r--CONTRIBUTING.md27
1 files changed, 20 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 02bbc4cd..1bfa34ac 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,7 +18,8 @@ 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. An
+ 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.
@@ -44,9 +45,9 @@ Guidelines for bug reports:
Example:
-> Short and descriptive example bug report title
+> Short and descriptive example bug report title.
>
-> Glances and psutil version used (glances -V)
+> Glances and psutil version used (glances -V).
>
> Operating system description (name and version).
>
@@ -63,6 +64,10 @@ Example:
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
+>
+> You can also run Glances in debug mode (-d) and paste/bin the glances.conf file (https://glances.readthedocs.io/en/latest/config.html).
+>
+> Glances 3.2.0 or higher have also a --issue option to run a simple test. Please use it and copy/paste the output.
## Feature requests
@@ -125,25 +130,33 @@ included in the project:
4. It's coding time !
Please respect the following coding convention: [Elements of Python Style](https://github.com/amontalenti/elements-of-python-style)
- Commit your changes in logical chunks. Please adhere to these [git commit
+
+5. Test you code using the Makefile:
+ make run ==> Run Glances
+ make run-webserver ==> Run a Glances Web Server
+ make test ==> Run unit tests
+ make docs ==> Update docs
+ make webui ==> Compile a new Web UI
+
+6. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.
-5. Locally merge (or rebase) the upstream development branch into your topic branch:
+7. Locally merge (or rebase) the upstream development branch into your topic branch:
```bash
git pull [--rebase] upstream develop
```
-6. Push your topic branch up to your fork:
+8. Push your topic branch up to your fork:
```bash
git push origin <topic-branch-name>
```
-7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+9. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `develop` branch.
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to