We'd love your contribution to our project and to make Speakerfight. Here are the guidelines we'd like you to follow:
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub repository. Even better you can submit a pull request with a fix.
Before you submit your issue search the archive, maybe your problem was already answered. Also check if there is no work in progress to fix your problem (when no issue to the problem was created).
Building the environment:
$ git clone git@github.com:luanfonceca/speakerfight.git
$ cd speakerfight
$ pip install -r requirements.txt
$ python manage.py migrate # we have a fixture for the users...
$ python manage.py loaddata deck/fixtures/user.json
# username: admin, password: admin;
# username: user, password: user
$ python manage.py loaddata deck/fixtures/event.json
$ python manage.py loaddata deck/fixtures/proposal.json
$ python manage.py loaddata deck/fixtures/socialapp.json
$ python manage.py runserver
Before you submit your pull request consider the following guidelines:
-
Make your changes in a new branch:
git checkout -b my-fix-branch master
-
Follow our Coding Rules.
-
Run the test suite:
python manage.py test -
Run code coverage:
coverage run manage.py test -
Commit your work, including appropriate test cases (unit tests, functional tests, regression tests, etc).
-
When commiting remember to write clear commit messages explaining why the change is important.
-
Run the test suite to ensure your code is working properly.
-
Push to the upstream and create a pull request against the master branch.
To ensure consistency throughout the source code, keep the following rules in mind:
- Speakerfight follows the same conventions Django uses.
- Some programming languages have their own coding style guide. EditorConfig is here to help us on this.
- All features or changes must be tested (your patch should have tests proving your code works as expected).
- Code coverage is important.