File: CONTRIBUTING.rst

package info (click to toggle)
python-django-split-settings 0.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 352 kB
  • sloc: python: 368; makefile: 23
file content (39 lines) | stat: -rw-r--r-- 917 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
============
Contributing
============

Testing
=======

We are using ``pytest``, ``pylint``, and ``tox`` for testing.
To run simple tests: ``python setup.py test``.
To run full tests:

.. code:: bash

    pip install tox
    tox

Make sure you have followed all the steps before submitting your PR.

Before submitting
=================

Before submitting your code please do the following steps:

	1. Run `tox` to make sure everything was working before
	2. Add any changes you want
	3. Adds tests for the new changes
	4. Edit documentation if you have changed something significant
	5. Run `tox` again to make sure it is still working

Other help
==========

You can contribute by spreading a word about this library.
It would also be a huge contribution to write a short article on how you are using this project. What are your best-practices?

Authors
=======

Do not forget to add yourself into ``AUTHORS.rst``.