Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.97 KB
Raw

Contributing to GraphQL Editor

We welcome contributions to GraphQL Editor of any kind including documentation, themes, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the forum, helping to manage issues, etc.

Changes to the codebase and related documentation, e.g. for a new feature, should still use a single pull request.

Table of Contents

Asking Support Questions

We have an discussion forum where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions.

Reporting Issues

If you believe you have found a defect in GraphQL Editor or its documentation, use the GitHub issue tracker to report the problem to the maintainers. If you're not sure if it's a bug or not, start by asking in the discussion forum.

Code Contribution

GraphQL Editor is still looking for its direction so remember functionality has to:

  • repair existing bugs
  • introduce new feature requests

Bug fixes are, of course, always welcome.

Submitting Patches

If you are interested in helping with the project, we will help you with your contribution. GraphQL Editor is a little bit complicated project touching many technologies feel free to ask us for help on discussion forum or slack channel

Code Contribution Guidelines

Because we want to create the best possible product for our users and the best contribution experience for our developers, we have a set of guidelines which ensure that all contributions are acceptable. The guidelines are not intended as a filter or barrier to participation. If you are unfamiliar with the contribution process, our team will help you and teach you how to bring your contribution in accordance with the guidelines.

To make the contribution process as seamless as possible, we ask for the following:

  • Go ahead and fork the project and make your changes. We encourage pull requests to allow for review and discussion of code changes.
  • When you’re ready to create a pull request, be sure to:
    • Add documentation if you are adding new features or changing functionality. The docs site lives in /docs.
    • Squash your commits into a single commit. git rebase -i. It’s okay to force update your pull request with git push -f.