Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 1.99 KB
Raw

Welcome to the GraphQl Rest Router contributing guide

Thank you for your interest in our project and its continued health!

This document's purpose is to explain our conventions, expectations and procedure for contributing to this code base.

Issues

Creating a new issue

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!

Before you create a ticket, navigate to issues page and ensure that there is not an existing ticket already filed.

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.

Please note:

  • Please be respectful of all community members and keep this environment collaborative, safe and suitable for all.

  • We will read and consider each issue filed but we cannot accomodate all requests.

Solving an issue

To address an existing issue or open a pr for a new item, please follow standard open source procedure.

Rules:

  1. Prove all applicable changes are working as expected with meaningful unit tests.

  2. Update the README.md with each change in functionality.

Steps:

  1. Fork the repository.

  2. Create a working branch and start with your changes!

  3. Commit the changes once you are happy with them and self review.

  4. Create a pull request and fill out all fields in the pull request template.

  5. Link the pull request to the issue with a link in the title. For example: Bugfix: Fix casing found Issue: [#${issueNumber}](https://github.com/Econify/graphql-rest-router/issues/${issueNumber}).

  6. Add repo contributors as reviewers.

  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.