Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 5.47 KB

CONTRIBUTING.md

File metadata and controls

115 lines (79 loc) · 5.47 KB
Raw

Contributing to graphql-js

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.

Issues

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 absolute best way to do that is to add a failing test to our test suite via a pull request, but a reduced test case on a site like StackBlitz or CodeSandbox is also very helpful.

Pull Requests

All active development of graphql-js happens on GitHub. We actively welcome your pull requests.

Considered Changes

Since graphql-js is a reference implementation of the GraphQL spec, only changes which comply with this spec will be considered. If you have a change in mind which requires a change to the spec, please consider opening an issue against the spec and/or attending a GraphQL Working Group meeting to discuss your proposed change. See the contribution guide of the specification for further information. Stage 1 and 2 proposals may be implemented within graphql-js behind a feature flag.

GraphQL Specification Membership Agreement

This repository is managed by EasyCLA. Project participants must sign the free GraphQL Specification Membership agreement before making a contribution. You only need to do this one time, and it can be signed by individual contributors or their employers.

To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.

You can find detailed information here. If you have issues, please email [email protected].

If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation.

Getting Started

  1. Fork this repo by using the "Fork" button in the upper-right

  2. Check out your fork

    git clone [email protected]:your_name_here/graphql-js.git

  3. Install or Update all dependencies

    npm install

  4. 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.

  5. Ensure all tests pass

    npm test

Coding Style

This project uses Prettier for standard formatting. To ensure your pull request matches the style guides, run npm run prettier.

  • 2 spaces for indentation (no tabs)
  • 80 character line length strongly preferred.
  • Prefer ' over "
  • ES6 syntax when possible. However do not rely on ES6-specific functions to be available.
  • Use TypeScript.
  • Use semicolons;
  • Trailing commas,
  • Avd abbr wrds.

Review and Merge Process

  • Pull requests are required to pass all tests and checks before they can be merged.
  • Ideally, pull requests should be reviewed by at least two members of the @graphql/graphql-js-reviewers team before they are merged, preferably from separate organizations. For more complex pull requests, a larger cohort of reviewers is suggested.
  • Any reviewer may request that the topic be brought for more in depth discussion at a GraphQL JS Working Group meeting, where decisions will be made by consensus.
  • A PR that has been merged without discussion at a GraphQL JS Working Group meeting can be revisited in any subsequent meeting; the PR may be reverted as a result of that discussion.

Discussion

Feel free to reach out via the graphql-js channel on the official Discord server to discuss issues, pull requests, or anything graphql-js related.

Release on NPM

Only core contributors may release to NPM.

To release a new version on NPM, first ensure all tests pass with npm test, then use npm version patch|minor|major in order to increment the version in package.json and tag and commit a release. Then git push && git push --tags to sync this change with source control. Then npm publish npmDist to actually publish the release to NPM. Once published, add release notes. Use semver to determine which version part to increment.

Example for a patch release:

npm ci
npm test
npm version patch
git push --follow-tags
cd npmDist && npm publish
npm run changelog

Then upload the changelog to https://github.com/graphql/graphql-js/releases.

License

By contributing to graphql-js, you agree that your contributions will be licensed under its MIT license.