-
-
Notifications
You must be signed in to change notification settings - Fork 138
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refs #151 -- Added the Jazzband contributing guideline and moved runn…
…ing tests to the README.
- Loading branch information
Showing
2 changed files
with
47 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters