File: contributing.rst

package info (click to toggle)
python-django-ratelimit 4.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 348 kB
  • sloc: python: 892; makefile: 134; sh: 49
file content (53 lines) | stat: -rw-r--r-- 834 bytes parent folder | download
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
.. _contributing-chapter:

============
Contributing
============


Set Up
======

Create a virtualenv_ and install Django with pip_:

.. code-block:: sh

    $ pip install Django


Running the Tests
=================

Running the tests is as easy as:

.. code-block:: sh

    $ ./run.sh test

You may also run the test on multiple versions of Django using tox.

- First install tox:

  .. code-block:: sh

      $ pip install tox

- Then run the tests with tox:

  .. code-block:: sh

      $ tox


Code Standards
==============

I ask two things for pull requests.

* The flake8_ tool must not report any violations.
* All tests, including new tests where appropriate, must pass.


.. _virtualenv: http://www.virtualenv.org/en/latest/
.. _pip: http://www.pip-installer.org/en/latest/
.. _flake8: https://pypi.python.org/pypi/flake8