From 4f38bf384bfa80a0860abfb5cde6eda8bf3b720c Mon Sep 17 00:00:00 2001 From: nicolargo Date: Sat, 18 May 2024 10:17:47 +0200 Subject: [PATCH] Add some comment regarding the minimal Python version and exclude all the venv* folders in the linter configuration --- CONTRIBUTING.md | 9 +++------ pyproject.toml | 3 +++ setup.py | 3 +++ 3 files changed, 9 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 (). > > 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 diff --git a/pyproject.toml b/pyproject.toml index 2380aff3..c5fb7e4a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -58,7 +58,10 @@ exclude = [ "dist", "node_modules", "venv", + "venv-dev", + "venv-min", "docs", + "test-data", "./glances/outputs/static/*" ] diff --git a/setup.py b/setup.py index d095cb84..d6f6ac6e 100755 --- a/setup.py +++ b/setup.py @@ -8,6 +8,9 @@ import sys from setuptools import Command, setup +# If the minimal Python version is changed then do not forget to change it in: +# - ./pyproject.toml +# - .github/workflows/test.yml if not (sys.version_info >= (3, 8)): print('Glances requires at least Python 3.8 to run.') sys.exit(1)