Skip to content

Commit

Permalink
Add Jazzband contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jleclanche committed Feb 10, 2018
1 parent 2ae27f9 commit 1be2f2a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
### Coding style
## Jazzband

[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/)

This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines).


## Coding style
This project follows the [HearthSim Styleguide](https://hearthsim.info/styleguide/).

In short:
Expand All @@ -11,9 +17,10 @@ In short:

Also see: [How to name things in programming](http://www.slideshare.net/pirhilton/how-to-name-things-the-hardest-problem-in-programming)

Flake8 tests are available with `tox -e flake8`. Run them before you commit!

### Commits and Pull Requests

## Commits and Pull Requests
Keep the commit log as healthy as the code. It is one of the first places new contributors will look at the project.

1. No more than one change per commit. There should be no changes in a commit which are unrelated to its message.
Expand Down
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ django-push-notifications
.. image:: https://api.travis-ci.org/jazzband/django-push-notifications.png
:target: https://travis-ci.org/jazzband/django-push-notifications

.. image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband

A minimal Django app that implements Device models that can send messages through APNS, FCM/GCM and WNS.

The app implements three models: ``GCMDevice``, ``APNSDevice`` and ``WNSDevice``. Those models share the same attributes:
Expand Down

0 comments on commit 1be2f2a

Please sign in to comment.