File: CONTRIBUTING.rst

package info (click to toggle)
python-django-formtools 1.0+20160714.git54f1ccca01-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 992 kB
  • ctags: 481
  • sloc: python: 2,070; makefile: 196
file content (55 lines) | stat: -rw-r--r-- 1,531 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
================================
Contributing to django-formtools
================================

As an open source project, django-formtools 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-formtools 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-formtools
    [..]
    $ cd django-formtools
    $ 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
    ...
    py35-django-AB
    py35-django-master

You can run each environment with the ``-e`` option::

    $ tox -e py35-django-AB  # runs the tests only on Python 3.5 and Django A.B.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 py35-django-AB

__ https://github.com/django/django-formtools/issues
__ https://tox.readthedocs.io/en/latest/install.html