File: CONTRIBUTING.rst

package info (click to toggle)
python-django-imagekit 4.0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 696 kB
  • sloc: python: 2,000; makefile: 133
file content (24 lines) | stat: -rw-r--r-- 1,200 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Contributing
------------

We love contributions! These guidelines will help make sure we can get your
contributions merged as quickly as possible:

1. Write `good commit messages`__!
2. If you want to add a new feature, talk to us on the `mailing list`__ or
   `IRC`__ first. We might already have plans, or be able to offer some advice.
3. Make sure your code passes the tests that ImageKit already has. To run the
   tests, first install tox, ``pip install tox``, then use ``tox``. This will let you know about any errors or style
   issues.
4. While we're talking about tests, creating new ones for your code makes it
   much easier for us to merge your code quickly. ImageKit uses nose_, so
   writing tests is painless. Check out `ours`__ for examples.
5. It's a good idea to do your work in a branch; that way, you can work on more
   than one contribution at a time without making them interdependent.


__ http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
__ https://groups.google.com/forum/#!forum/django-imagekit
__ irc://irc.freenode.net/imagekit
.. _nose: https://nose.readthedocs.org/en/latest/
__ https://github.com/matthewwithanm/django-imagekit/tree/develop/tests