contribution details moved to contribution.md (#311)

* adapted contribution hints and created contribution.md
This commit is contained in:
lothar schulz
2016-09-20 14:35:29 +02:00
committed by Oleksii Kliukin
parent 453e68637a
commit 1100136d8d
2 changed files with 23 additions and 12 deletions
+19
View File
@@ -0,0 +1,19 @@
# Contributing guidelines
Wanna contribute to Patroni? Yay - here is how!
## Filing issues
If you have a question about patroni or have a problem using it, please read the [readme]( README.rst) before filing an issue.
Also double check with the current issues on our [Issues Tracker](https://github.com/zalando/patroni/issues).
## Contributing a pull request
1. Submit a comment to the relevant issue or create a new issue describing your proposed change.
1. Do a fork, develop and test your code changes.
1. Include documentation
1. Submit a pull request.
You'll get feedback about your pull request as soon as possible.
Happy Patroni hacking ;-)
+1 -9
View File
@@ -32,7 +32,7 @@ For additional background info, see:
Development Status
================
Patroni is in active development and accepts contributions. See our `Contributing <https://github.com/zalando/patroni/blob/master/README.rst#contributing>`__ section below for more details.
Patroni is in active development and accepts contributions. See our `Contributing <https://github.com/zalando/patroni/blob/master/CONTRIBUTING.md>`__ section below for more details.
===========================
Technical Requirements/Installation
@@ -114,14 +114,6 @@ Applications Should Not Use Superusers
When connecting from an application, always use a non-superuser. Patroni requires access to the database to function properly. By using a superuser from an application, you can potentially use the entire connection pool, including the connections reserved for superusers, with the ``superuser_reserved_connections`` setting. If Patroni cannot access the Primary because the connection pool is full, behavior will be undesirable.
================
Contributing
================
Patroni accepts contributions from the open-source community; see the `Issues Tracker <https://github.com/zalando/patroni/issues>`__ for current needs.
Before making a contribution, please let us know by posting a comment to the relevant issue.
If you would like to propose a new feature, please first file a new issue explaining the feature you'd like to create.
.. |Build Status| image:: https://travis-ci.org/zalando/patroni.svg?branch=master
:target: https://travis-ci.org/zalando/patroni
.. |Coverage Status| image:: https://coveralls.io/repos/zalando/patroni/badge.svg?branch=master