diff options
| author | nicolargo <nicolashennion@gmail.com> | 2024-05-18 10:17:47 +0200 |
|---|---|---|
| committer | nicolargo <nicolashennion@gmail.com> | 2024-05-18 10:17:47 +0200 |
| commit | 4f38bf384bfa80a0860abfb5cde6eda8bf3b720c (patch) | |
| tree | 74e2b1568f96d7e2e29325f9abb24d74747c02db /CONTRIBUTING.md | |
| parent | 6a0889851cc7df4e555bb72cd39acc14777abe32 (diff) | |
Add some comment regarding the minimal Python version and exclude all the venv* folders in the linter configurationruff-cleanup
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad1282c4..ddab0ac5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,6 @@ the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features. - ## Using the issue tracker The [issue tracker](https://github.com/nicolargo/glances/issues) is @@ -24,7 +23,6 @@ restrictions: * Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. - ## Bug reports A bug is a _demonstrable problem_ that is caused by the code in the repository. @@ -65,19 +63,17 @@ Example: > 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). +> 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 Feature requests are welcome. But take a moment to find out whether your idea -fits with the scope and aims of the project. It's up to *you* to make a strong +fits with the scope and aims of the project. It's up to _you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible. - ## Pull requests Good pull requests—patches, improvements, new features—are a fantastic @@ -133,6 +129,7 @@ included in the project: 5. Test you code using the Makefile: + * make format ==> Format your code thanks to the Ruff linter * make run ==> Run Glances * make run-webserver ==> Run a Glances Web Server * make test ==> Run unit tests |