Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.49 KB

CONTRIBUTING.rst

File metadata and controls

55 lines (37 loc) · 1.49 KB
Raw

Contributing to django-localflavor

As an open source project, django-localflavor welcomes contributions of many forms, similar to its origin in the Django framework.

Examples of contributions include:

  • Code patches
  • Documentation improvements
  • Bug reports and patch reviews

Extensive contribution guidelines are available online at:

https://docs.djangoproject.com/en/dev/internals/contributing/

File a ticket to suggest changes or send pull requests.

django-localflavor uses Github's issue system to keep track of bugs, feature requests, and pull requests for patches.

Running tests is as simple as installing Tox and running it in the root Git clone directory:

$ git clone https://github.com/django/django-localflavor
[..]
$ cd django-localflavor
$ tox
[..]
  congratulations :)

The previous command will run the tests in different combinations of Python (if available) and Django versions. To see the full list of combinations use the -l option:

$ tox -l
docs
...
py311-master

You can run each environment with the -e option:

$ tox -e py311-4.2  # runs the tests only on Python 3.11 and Django 4.2.x

Optionally you can also specify a country whose tests you want to run:

$ COUNTRY=us tox

And combine both options:

$ COUNTRY=us tox -e py311-4.2