Skip to content

Commit 89698ce

Browse files
committed
Reference Google style guide in developer docs
1 parent 563e5c3 commit 89698ce

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/development.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ Use `./gradlew spotlessApply` to run the automatic code formatter.
3030
You can also run it in continuous mode as `./gradlew --continuous spotlessApply`
3131
to reformat whenever a file changes.
3232

33+
We mean to follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html),
34+
but do not enforce it comprehensively (apart from what the automatic formatter does).
35+
Take particular note of the rules:
36+
37+
- [3.3.1 No wildcard imports](https://google.github.io/styleguide/javaguide.html#s3.3.1-wildcard-imports)
38+
- [5.3 Camel case: defined](https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
39+
(`XmlHttpRequest` and `requestId`, not `XMLHTTPRequest` and `requestID`)
40+
41+
In case of disagreement on code style, defer to the style guide.
42+
3343

3444
Setup for publishing
3545
---

0 commit comments

Comments
 (0)