Skip to content

Commit 93cbb66

Browse files
committed
doc(CONTRIBUTING) Add contributing.md
1 parent a59480e commit 93cbb66

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/contributing.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
Thanks for getting involved! I hope the information below will help you contribute to graphql-ruby.
4+
5+
## Issues
6+
7+
When reporting a bug, please include these details when applicable:
8+
9+
- `graphql` version and other applicable versions (Rails, `graphql-batch`, etc)
10+
- Definitions of schema or relevant types and fields (in Ruby is best, in GraphQL IDL is ok)
11+
- Example GraphQL query and response (if query execution is involved)
12+
- Full backtrace (if a Ruby exception is involved)
13+
14+
With these details, we can efficiently hunt down the bug!
15+
16+
## Code
17+
18+
It's important for code to fit in with design and maintenance goals of the project. For this reason, consider an issue to discuss new features or large refactors. That way we can work together to find suitable solution!
19+
20+
## Legal
21+
22+
By submitting a Pull Request, you disavow any rights or claims to any changes submitted to `graphql-ruby` and assign the copyright of those changes to Robert Mosolgo, the author and maintainer of `graphql-ruby`. If you cannot or don't want to reassign those rights (your employment contract for your employer may not allow this), don't submit a PR. Instead, open an issue so that someone else can give it a try.
23+
24+
In short, contributing code means that the code belongs to the maintainer. That's generally what you want, since the burden of upkeep, support and distribution falls on the maintainer anyways. I hope this doesn't prohibit you from contributing!

0 commit comments

Comments
 (0)