Skip to content

Commit

Permalink
[fix] add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mosquito committed Jun 20, 2017
1 parent 94f1bc6 commit 12f7637
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,21 @@ Usage example
loop.run_until_complete(main(loop))
See another examples and the tutorial in `documentation`_.
See another examples and the tutorial in `documentation`_.


For contributors
----------------

You feel free to create pull request, but you should describe your cases and add some examples.

The changes should follow simple rules:

* When your changes break public API you must increase the major version.
* When your changes is safe for public API (e.g. added an argument with default value)
* You have to add test cases (see `tests/` folder)
* You must add docstrings
* You feel free to add yourself to `"thank's to" section`_


.. _"thank's to" section: https://github.com/mosquito/aio-pika/blob/master/docs/source/index.rst#thanks-for-contributing

0 comments on commit 12f7637

Please sign in to comment.