Important

The development of django-freeradius has moved to openwisp-radius, we highly suggest users and readers of this documentation to migrate or use the more up to date documentation of openwisp-radius.

Contributing

Thank you for taking the time to contribute to django-freeradius.

Follow these guidelines to speed up the process.

Table of Contents:

• Contributing
  • Setup
  • Ensure test coverage does not decrease
  • Follow style conventions (PEP8, isort, JSLint)
  • Update the documentation
  • Send pull request

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

Ensure test coverage does not decrease

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=django_freeradius runtests.py

Follow style conventions (PEP8, isort, JSLint)

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 the style conventions with:

./runflake8
./runisort
jslint ./django_freeradius/static/django-freeradius/js/*.js

For more information, please see:

• PEP8: Style Guide for Python Code
• isort: a python utility / library to sort imports

Update the documentation

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

Send pull request

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