We want to make contributing to this project as easy and transparent as possible. Hopefully this document makes the process for contributing clear and answers any questions you may have. If not, feel free to open an Issue.
We use GitHub issues to track public bugs and requests. Please ensure your bug description is clear and has sufficient instructions to be able to reproduce the issue. The best way is to provide a reduced test case on jsFiddle or jsBin.
All active development of this project happens on GitHub. We actively welcome your pull requests.
Since GraphiQL and related tools are used by a wide range of companies, individuals and other projects, changes which are of obvious benefit are prioritized and changes which are specific to only some usage of GraphiQL should first consider if they may use the existing customization hooks or if they should expose a new customization hook.
-
Fork this repo by using the "Fork" button in the upper-right
-
Check out your fork
git clone [email protected]:yournamehere/graphiql.git
-
Install or Update all dependencies
yarn
-
Get coding! If you've added code, add tests. If you've changed APIs, update any relevant documentation or tests. Ensure your work is committed within a feature branch.
-
Ensure all tests pass
yarn test
Our commit messages are linted by commitlint following the angular changelog convention. You may end up losing a commit message or two if you don't follow this rule. We can add a prompt if people ask for it. This was designed for compatiblity with various git clients.
Please see the RELEASING.md document.
By contributing to GraphiQL, you agree that your contributions will be licensed under the LICENSE file in the project root directory.