Skip to content

Commit

Permalink
docs: Add a CONTRIBUTING.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanahsmith committed Nov 24, 2016
1 parent 7719d66 commit 30cf47c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,22 @@
# Contributing

Issues, bug fixes and documentation for existing features are always
welcome.

## Proposing Features

The focus on this project is on providing a convenient way to access
the schema for code generators targetting different langauges.
Features that aren't relevant for this use case are less likely to
be merged. When in doubt, open an issue first to propose the issue
so that we can confirm that we are interested in a pull request to
implement it.

## How To Contribute

1. Fork the [repository in github](https://github.com/Shopify/graphql_schema)
2. Create your feature branch (`git checkout -b fix-feature`)
3. Commit your changes (`git commit -am 'fix: Summarize change'`)
3. Make sure all tests pass (`bundle exec rake`)
4. Push to the branch (`git push origin fix-feature`)
5. [Create new pull request](https://github.com/Shopify/graphql_schema/pulls)
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -42,7 +42,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/graphql_schema.
See our [contributing guidelines](CONTRIBUTING.md) for more information.

## License

Expand Down

0 comments on commit 30cf47c

Please sign in to comment.