|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +We are really glad you are reading this, because we need volunteer developers to help this project. |
| 4 | + |
| 5 | +If you have not already, come find us in [](https://gitter.im/pgRouting/pgrouting?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or contact us via [mailing list](http://lists.osgeo.org/mailman/listinfo/pgrouting-dev). We want you working on things you're excited about. Drop a message and if some one can assist you, will contact you back ASAP. |
| 6 | + |
| 7 | +Here are some important resources: |
| 8 | + |
| 9 | + * [pgRouting Documentation](http://docs.pgrouting.org/) The plugin is based on pgRouting |
| 10 | + * [Wish list on the wiki](https://github.com/pgRouting/pgrouting/wiki/GSoC-Ideas) is the foot view of what we think the community needs and can be done by GSoC students. |
| 11 | + * [Additional wish list](https://github.com/pgRouting/osm2pgrouting/issues?q=is%3Aopen+is%3Aissue+label%3A%22Functionality+Request%22). |
| 12 | + * Participate on the [discussions](https://github.com/pgRouting/osm2pgrouting/issues?q=is%3Aopen+is%3Aissue+label%3ADiscussion). |
| 13 | + * Participate fixing [Documentation](https://github.com/pgRouting/osm2pgrouting/issues?q=is%3Aopen+is%3Aissue+label%3ADocumentation). |
| 14 | + * Find a bug? [Let us know](https://github.com/pgRouting/osm2pgrouting/issues). |
| 15 | + |
| 16 | +## Contribution agreement |
| 17 | + |
| 18 | +Any kind of contribution will automatically fall to the following Licences: |
| 19 | + |
| 20 | +- Code contribution: GNU GENERAL PUBLIC LICENSE Version 2, |
| 21 | + - Directly by making a pul explicit pull request. |
| 22 | + - Indirectly by posting code on issues/wiki/gitter/mailng lists |
| 23 | +- Documentation contribution: |
| 24 | + - Creative Commons Attribution-Share Alike 3.0 |
| 25 | + |
| 26 | +## Submitting changes |
| 27 | + |
| 28 | + |
| 29 | +Write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should have more information. |
| 30 | +Fill the commit message template. |
| 31 | + |
| 32 | +## Coding conventions |
| 33 | + |
| 34 | +This is open source software. Consider the people who will read your code, and make it look nice for them. |
| 35 | + |
| 36 | + * We indent using four spaces (soft tabs) |
| 37 | + |
| 38 | +Thanks, |
| 39 | +pgRouting team |
0 commit comments