Skip to content

Commit 14c9022

Browse files
committed
add contribution guidelines
1 parent 876c9db commit 14c9022

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Thanks for contributing to graphql-java!
2+
3+
4+
Please be sure that you read the [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to this project
5+
and please create a new Issue and discuss first what your are planing todo for bigger changes.
6+
7+
8+
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.
9+
10+
In order to achieve that we have a strong focus on maintainability and high test coverage:
11+
12+
- We expect new or modified unit test for every change (written in [Spock](http://spockframework.org/)).
13+
14+
- Your code should should be formatted with our IntelliJ [graphql-java-code-style](graphql-java-code-style.xml).
15+
16+
- We don't add a new dependency to graphql-java: dependency conflicts will make adaption of graphql-java harder for users,
17+
therefore we avoid adding any new dependency.
18+
19+
- graphql-java has a strict focus on executing a GraphQL request, this means JSON parsing, http communication, databases
20+
access etc is out of scope.
21+
22+
23+
If you have any question please open a Issue.
24+
25+
Thanks!
26+
27+

graphql-java-code-style.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<code_scheme name="graphql-java" version="173">
2+
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
3+
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
4+
<option name="JD_ADD_BLANK_AFTER_PARM_COMMENTS" value="true"/>
5+
<option name="JD_ADD_BLANK_AFTER_RETURN" value="true"/>
6+
<option name="JD_P_AT_EMPTY_LINES" value="false"/>
7+
<GroovyCodeStyleSettings>
8+
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
9+
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
10+
</GroovyCodeStyleSettings>
11+
<JavaCodeStyleSettings>
12+
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
13+
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999"/>
14+
<option name="JD_ADD_BLANK_AFTER_PARM_COMMENTS" value="true"/>
15+
<option name="JD_ADD_BLANK_AFTER_RETURN" value="true"/>
16+
<option name="JD_P_AT_EMPTY_LINES" value="false"/>
17+
</JavaCodeStyleSettings>
18+
</code_scheme>

0 commit comments

Comments
 (0)