Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 2.35 KB
Raw

How to contribute

Support and contributions from the open source community are essential for keeping the graphql-schema up to date and always improving! There are a few guidelines that we need contributors to follow to keep the project consistent, as well as allow us to keep maintaining graphql-schema in a reasonable amount of time.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Creating an Issue

Before you create a new Issue:

  • Check the Issues on GitHub to ensure one doesn't already exist.
  • Clearly describe the issue, including the steps to reproduce the issue.
  • Please include links to the corresponding github documentation.

Making Changes

  • Create a topic branch from the main branch.
  • Check for unnecessary whitespace / changes with git diff --check before committing.
  • Keep git commit messages clear and appropriate. Ideally follow commit conventions described below.

Submitting the Pull Request

  • Push your changes to your topic branch on your fork of the repo.
  • Submit a pull request from your topic branch to the main branch on the graphql-schema repository.
  • Be sure to tag any issues your pull request is taking care of / contributing to.
  • Adding "Closes #123" to a pull request description will auto close the issue once the pull request is merged in.

Merging the Pull Request & releasing a new version

Releases are automated using semantic-release. The following commit message conventions determine which version is released:

  1. fix: ... or fix(scope name): ... prefix in subject: bumps fix version, e.g. 1.2.3 → 1.2.4
  2. feat: ... or feat(scope name): ... prefix in subject: bumps feature version, e.g. 1.2.3 → 1.3.0
  3. BREAKING CHANGE: in body: bumps breaking version, e.g. 1.2.3 → 2.0.0

Only one version number is bumped at a time, the highest version change trumps the others. Besides publishing a new version to npm, semantic-release also creates a git tag and release on GitHub, generates changelogs from the commit messages and puts them into the release notes.

If the pull request looks good but does not follow the commit conventions, use the "Squash & merge" button.