Skip to content

Commit b670381

Browse files
authored
Merge pull request #367 from Yubico/dev-docs
Reference Google style guide in developer docs
2 parents 563e5c3 + 2fc2470 commit b670381

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

doc/development.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,23 @@ 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
---
3646

37-
To enable publishing to Maven Central via Sonatype Nexus, set
38-
`yubicoPublish=true` in `$HOME/.gradle/gradle.properties` and add your Sonatype
47+
To enable publishing to Maven Central via Sonatype Nexus,
48+
[generate a user token](https://central.sonatype.org/publish/generate-token/).
49+
Set `yubicoPublish=true` in `$HOME/.gradle/gradle.properties` and add your token
3950
username and password. Example:
4051

4152
```properties

0 commit comments

Comments
 (0)