Permalink
Browse files

add contribution guidelines

  • Loading branch information...
andimarek committed May 12, 2018
1 parent 876c9db commit 14c9022b059965ed273e30e99e6b9dadeda574da
Showing with 45 additions and 0 deletions.
  1. +27 −0 CONTRIBUTING.md
  2. +18 −0 graphql-java-code-style.xml
@@ -0,0 +1,27 @@
Thanks for contributing to graphql-java!
Please be sure that you read the [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to this project
and please create a new Issue and discuss first what your are planing todo for bigger changes.
The overall goal of graphql-java is to have a correct implementation of the [GraphQL Spec](https://github.com/facebook/graphql/) in a production ready way.
In order to achieve that we have a strong focus on maintainability and high test coverage:
- We expect new or modified unit test for every change (written in [Spock](http://spockframework.org/)).
- Your code should should be formatted with our IntelliJ [graphql-java-code-style](graphql-java-code-style.xml).
- We don't add a new dependency to graphql-java: dependency conflicts will make adaption of graphql-java harder for users,
therefore we avoid adding any new dependency.
- graphql-java has a strict focus on executing a GraphQL request, this means JSON parsing, http communication, databases
access etc is out of scope.
If you have any question please open a Issue.
Thanks!
@@ -0,0 +1,18 @@
<code_scheme name="graphql-java" version="173">
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
<option name="JD_ADD_BLANK_AFTER_PARM_COMMENTS" value="true"/>
<option name="JD_ADD_BLANK_AFTER_RETURN" value="true"/>
<option name="JD_P_AT_EMPTY_LINES" value="false"/>
<GroovyCodeStyleSettings>
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
</GroovyCodeStyleSettings>
<JavaCodeStyleSettings>
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
<option name="JD_ADD_BLANK_AFTER_PARM_COMMENTS" value="true"/>
<option name="JD_ADD_BLANK_AFTER_RETURN" value="true"/>
<option name="JD_P_AT_EMPTY_LINES" value="false"/>
</JavaCodeStyleSettings>
</code_scheme>

0 comments on commit 14c9022

Please sign in to comment.