Skip to content

Commit c48aa91

Browse files
committed
Add contribution guide
1 parent 074ed04 commit c48aa91

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# How to contribute
2+
3+
We're really glad you're reading this, because we need more volunteer developers
4+
to help with this project! If you haven't already, connect with us on
5+
[Spectrum](https://spectrum.chat/graphql-java-kick?tab=posts).
6+
7+
We can use all the help we can get on all our [GraphQL Java Kickstart](https://github.com/graphql-java-kickstart)
8+
projects. This work ranges from adding new features, fixing bugs, and answering questions to writing documentation.
9+
10+
## Answering questions and writing documentation
11+
12+
A lot of the questions asked on Spectrum or Github are caused by a lack of documentation.
13+
We should strive from now on to answer questions by adding content to
14+
our [documentation](https://github.com/graphql-java-kickstart/documentation) and referring
15+
them to the newly created content.
16+
17+
Continuous integration will make sure that the changes are automatically deployed to
18+
https://www.graphql-java-kickstart.com.
19+
20+
## Submitting changes
21+
22+
Please send a Pull Request with a clear list of what you've done using the
23+
[Github flow](https://guides.github.com/introduction/flow/). We can always use more
24+
test coverage, so we'd love to see that in the pull requests too. And make sure to
25+
follow our coding conventions (below) and make sure all your commits are atomic
26+
(one feature per commit).
27+
28+
## Coding conventions
29+
30+
We use Google Style guides for our projects. See the
31+
[Java Style Guide](https://google.github.io/styleguide/javaguide.html) for a detailed
32+
description. You can download the
33+
[IntelliJ Java Google Style](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)
34+
to import in these settings in IntelliJ.

0 commit comments

Comments
 (0)