Skip to content

Commit a85ba6f

Browse files
smyrickmykevinjung
authored andcommitted
Update documentation (ExpediaGroup#328)
Clean up the README and add CONTRIBUTING docs to prepare for the 1.0.0 release
1 parent 2ea0d54 commit a85ba6f

File tree

2 files changed

+60
-2
lines changed

2 files changed

+60
-2
lines changed

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing
2+
3+
`graphql-kotlin` is open source and welcomes contributions. We do ask that you help us maintain a clean library and create the best code for everyone to use.
4+
5+
## Build
6+
You can use Maven to build all the modules from the root directory
7+
8+
```shell script
9+
mvn clean install
10+
```
11+
12+
Or you can navigate to each module to build them
13+
14+
## Testing
15+
16+
### Unit Tests
17+
18+
We are using [mockk](http://mockk.io), [JUnit](https://junit.org/junit5/), and [jacoco](https://www.eclemma.org/jacoco/) for our main testing libraries. This ensures we have good code coverage and can easily test all cases of schema generation.
19+
20+
To run tests use Maven
21+
22+
```shell script
23+
mvn verify
24+
```
25+
26+
You can also view the code coverage reports published to Codecov. Links in the README
27+
28+
### Linting
29+
We are also [ktlint](https://ktlint.github.io/) and [detekt](https://arturbosch.github.io/detekt/) for code style checking and linting. These can be run wiht the following Maven commands
30+
31+
**Note**:
32+
These will be run as part of the `validate` phase of a full build but if you want to run them manually you will have to navigate to each module directory and run the command
33+
34+
```shell script
35+
mvn antrun:run@ktlint
36+
```
37+
```shell script
38+
mvn antrun:run@detekt
39+
```
40+
41+
## License
42+
43+
See [LICENSE](LICENSE)

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,30 @@
77

88
GraphQL Kotlin consists of number of libraries that aim to simplify GraphQL integration for Kotlin applications.
99

10-
## Modules
10+
## 📦 Modules
1111

1212
* [graphql-kotlin-federation](/graphql-kotlin-federation) - Schema generator extension to build federated GraphQL schemas
1313
* [graphql-kotlin-schema-generator](/graphql-kotlin-schema-generator) - Code only GraphQL schema generation for Kotlin
1414
* [examples/spring](/examples/spring) - Example SpringBoot app that uses GraphQL Kotlin schema generator
1515
* [examples/federation](/examples/federation) - Example Federation module with multiple SpringBoot apps that use GraphQL Kotlin federation generator
1616

17-
## Documentation
17+
## 📋 Documentation
1818

1919
Examples and documentation are available on our [Uncyclo](https://github.com/ExpediaGroup/graphql-kotlin/wiki) or in each module.
2020

2121
If you have a question about something you can not find in our wiki, the indivdual modules, or javadocs, feel free to [create an issue](https://github.com/ExpediaGroup/graphql-kotlin/issues) and tag it with the question label.
22+
23+
## 👥 Contact
24+
25+
This project is part of Expedia Group open source but also maintained by a dedicated team
26+
27+
* Expedia Group
28+
* https://expediagroup.com/
29+
30+
31+
* `@ExpediaGroup/graphql-kotlin-committers`
32+
* Tag us in an issue on Github
33+
34+
## ✏️ Contributing
35+
36+
See more info in [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)