Contributing

Thank you for taking the time to contribute to openwisp-radius, please read the guide for contributing to openwisp repositories.

Follow these guidelines to speed up the process.

Note

In order to have your contribution accepted faster, please read the OpenWISP contributing guidelines and make sure to follow its guidelines.

Setup

Once you have chosen an issue to work on, setup your machine for development.

First of all, install the test requirements:

workon radius  # activate virtualenv
pip install --no-cache-dir -U -r requirements-test.txt

When you introduce changes, ensure test coverage is not decreased with:

coverage run --source=openwisp_radius runtests.py

First of all, install the test requirements:

workon radius  # activate virtualenv
pip install --no-cache-dir -U -r requirements-test.txt
npm install -g jslint

Before committing your work check that your changes are not breaking our coding style conventions:

# reformat the code according to the conventions
openwisp-qa-format
# run QA checks
./run-qa-checks

For more information, please see:

If you introduce new features or change existing documented behavior, please remember to update the documentation!

The documentation is located in the /docs directory of the repository.

To do work on the docs, proceed with the following steps:

workon radius  # activate virtualenv
pip install sphinx
cd docs
make html

Now is time to push your changes to github and open a pull request!