|
| 1 | +# Welcome to the GraphQl Rest Router contributing guide |
| 2 | + |
| 3 | +Thank you for your interest in our project and its continued health! |
| 4 | + |
| 5 | +This document's purpose is to explain our conventions, expectations and procedure for contributing to this code base. |
| 6 | + |
| 7 | +## Issues |
| 8 | +### Creating a new issue |
| 9 | +If you have a feature request, see a discrepency in our documentation or have found a bug, we strongly encourage you to help us better this library! |
| 10 | + |
| 11 | +Before you create a ticket, navigate to [issues](https://github.com/Econify/graphql-rest-router/issues) page and ensure that there is not an existing ticket already filed. |
| 12 | + |
| 13 | +If none are found, please create a new feature or bug ticket from our templates -- ensuring that all the following areas are covered with enough detail to action. |
| 14 | + |
| 15 | +Please note: |
| 16 | +* Please be respectful of all community members and keep this environment collaborative, safe and suitable for all. |
| 17 | + |
| 18 | +* We will read and consider each issue filed but we cannot accomodate all requests. |
| 19 | + |
| 20 | +### Solving an issue |
| 21 | +To address an existing [issue](https://github.com/Econify/graphql-rest-router/issues) or open a pr for a new item, please follow standard open source procedure. |
| 22 | + |
| 23 | +Rules: |
| 24 | + |
| 25 | +1. Prove all applicable changes are working as expected with meaningful unit tests. |
| 26 | + |
| 27 | +2. Update the [README.md](https://github.com/Econify/graphql-rest-router/blob/master/README.md) with each change in functionality. |
| 28 | + |
| 29 | +Steps: |
| 30 | +1. Fork the repository. |
| 31 | + |
| 32 | +2. Create a working branch and start with your changes! |
| 33 | + |
| 34 | +3. Commit the changes once you are happy with them and self review. |
| 35 | + |
| 36 | +4. Create a pull request and fill out all fields in the pull request template. |
| 37 | + |
| 38 | +5. Link the pull request to the issue with a link in the title. For example: |
| 39 | + `Bugfix: Fix casing found Issue: [#${issueNumber}](https://github.com/Econify/graphql-rest-router/issues/${issueNumber})`. |
| 40 | + |
| 41 | +6. Add repo contributors as reviewers. |
| 42 | + |
| 43 | +7. At our earliest convenience, the team will review the proposed changes. It is highly likely we will pose questions and request more information or even changes. |
0 commit comments