mirror
/
glances
mirror of https://github.com/nicolargo/glances.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add some comment regarding the minimal Python version and exclude all the venv* folders in the linter configuration

This commit is contained in:
nicolargo 2024-05-18 10:17:47 +02:00
parent 6a0889851c
commit 4f38bf384b
3 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -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 they should reciprocate that respect in addressing your issue or assessing
patches and features. patches and features.
## Using the issue tracker ## Using the issue tracker
The [issue tracker](https://github.com/nicolargo/glances/issues) is 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 * Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others. respect the opinions of others.
## Bug reports ## Bug reports
A bug is a _demonstrable problem_ that is caused by the code in the repository. 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 > causing the bug, and potential solutions (and your opinions on their
> merits). > 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. > 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
Feature requests are welcome. But take a moment to find out whether your idea 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 case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible. provide as much detail and context as possible.
## Pull requests ## Pull requests
Good pull requests—patches, improvements, new features—are a fantastic 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: 5. Test you code using the Makefile:
* make format ==> Format your code thanks to the Ruff linter
* make run ==> Run Glances * make run ==> Run Glances
* make run-webserver ==> Run a Glances Web Server * make run-webserver ==> Run a Glances Web Server
* make test ==> Run unit tests * make test ==> Run unit tests

3
pyproject.toml
View File

@ -58,7 +58,10 @@ exclude = [
"dist", "dist",
"node_modules", "node_modules",
"venv", "venv",
"venv-dev",
"venv-min",
"docs", "docs",
"test-data",
"./glances/outputs/static/*" "./glances/outputs/static/*"
] ]

3
setup.py
View File

@ -8,6 +8,9 @@ import sys
from setuptools import Command, setup 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)): if not (sys.version_info >= (3, 8)):
print('Glances requires at least Python 3.8 to run.') print('Glances requires at least Python 3.8 to run.')
sys.exit(1) sys.exit(1)