Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.26 KB
Raw

Contribution Guidelines

Please review the WLAN Pi contribution guidelines and policies.

Development Setup ('without pip install or pipx', 'may be recommended for development work'):

cd <where your dev folder is>
git clone <repo>
cd <repo>
virtualenv venv
source venv/bin/activate
pip install -U pip pip-tools setuptools wheel
pip install -r requirements.txt
sudo ./venv/bin/python3 -m profiler 
sudo ./venv/bin/python3 -m profiler <optional params>
sudo ./venv/bin/python3 -m profiler -c 44 -s "dev" -i wlan2 --no11r --logging debug

Before You Start

Create an issue and get it approved before you start on Pull Request (PR). Aligning your ideas with the project team will save everybody's time.

Pull Requests

Before submitting a PR perform the following:

  1. Lint your code with tox -e lint and make sure it minimally passes the checks.

  2. Format your code with tox -e format (this will run autoflake with desired options, black, and isort on the profiler codebase)

  3. Create a test that validates your changes. this test should go in /tests.

  4. Ensure your tests pass by running tox.

Failure to do this means it will take longer to test, validate, and merge your PR into the repo.