Contributions and issues are most welcome! All issues and pull requests are handled through GitHub on the ambitioninc repository. Also, please check for any existing issues before filing a new one. If you have a great idea but it involves big changes, please file a ticket before making a pull request! We want to make sure you don't spend your time coding something that might not fit the scope of the project.
To get the source source code and run the unit tests, run:
git clone git://github.com/ambitioninc/django-entity.git
cd django-entity
virtualenv env
. env/bin/activate
python setup.py install
coverage run setup.py test
coverage report --fail-under=100While 100% code coverage does not make a library bug-free, it significantly reduces the number of easily caught bugs! Please make sure coverage is at 100% before submitting a pull request!
For code quality, please run flake8:
pip install flake8
flake8 .Please arrange imports with the following style
# Standard library imports
import os
# Third party package imports
from mock import patch
from django.conf import settings
# Local package imports
from entity.version import __version__Please follow Google's python style guide wherever possible.
Before a new release, please go through the following checklist:
- Bump version in entity/version.py
- Git tag the version
- Upload to pypi:
pip install wheel
python setup.py sdist bdist_wheel upload For any security issues, please do NOT file an issue or pull request on GitHub! Please contact security@ambition.com with the GPG key provided on Ambition's website.