Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to GraphQL Schema Decorator

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to GraphQL Schema Decorator,
which is hosted in the [GraphQL Schema Decorator](https://github.com/indigotech/graphql-schema-decorator) on GitHub.
These are just guidelines, not rules, use your best judgment and feel free to
propose changes to this document in a pull request.

## Submitting Issues

* You can create an issue [here](https://github.com/indigotech/template-node/issues), but before doing it, please read the notes below on submitting issues.
* The issue title should have the issue type, like in the following example: `[BUG] Endpoint does not work`.
* Include screenshots or pieces of code whenever possible, they are very helpful.
* Include as many details as possible about your report.

## Pull Requests

* Use the following examples branch name pattern:
- `feature/add-endpoint`
- `bugfix/missing-fields`
- `enhancement/add-fields`
- `docs/update-readme`
- `chore/config-staging`

* Reference issues when creating the pull request. Make sure to add a reference to the issue like this: `Issue #48`.
* Make sure to create test for all feature added. Also run the test before commiting any changes: `npm test`.
* Verify if there are any documents in need of updates.
* Include screenshots and animated GIFs in your pull request whenever possible.

## Git Commit Messages

* Use the present tense ("Add feature" not "Added feature")
* Limit the first line to 72 characters or less