Skip to content

Commit

Permalink
Refs #151 -- Added the Jazzband contributing guideline and moved runn…
Browse files Browse the repository at this point in the history
…ing tests to the README.
  • Loading branch information
felixxm committed Oct 4, 2019
1 parent e3d259d commit 8c78600
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 55 deletions.
63 changes: 8 additions & 55 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,55 +1,8 @@
================================
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
.. image:: https://jazzband.co/static/img/jazzband.svg
:target: https://jazzband.co/
:alt: Jazzband

This is a `Jazzband <https://jazzband.co>`_ project. By contributing you agree
to abide by the `Contributor Code of Conduct
<https://jazzband.co/about/conduct>`_ and follow the `guidelines
<https://jazzband.co/about/guidelines>`_.
39 changes: 39 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,42 @@ To get more help:

* Join the django-users mailing list, or read the archives, at
https://groups.google.com/group/django-users.

Contributing to django-formtools
--------------------------------

See ``CONTRIBUTING.rst`` for information about contributing patches to
``django-formtools``.

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://tox.readthedocs.io/en/latest/install.html

0 comments on commit 8c78600

Please sign in to comment.