Skip to content

Commit

Permalink
Merge pull request #367 from Yubico/dev-docs
Browse files Browse the repository at this point in the history
Reference Google style guide in developer docs
  • Loading branch information
emlun authored Jul 12, 2024
2 parents 563e5c3 + 2fc2470 commit b670381
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions doc/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,23 @@ Use `./gradlew spotlessApply` to run the automatic code formatter.
You can also run it in continuous mode as `./gradlew --continuous spotlessApply`
to reformat whenever a file changes.

We mean to follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html),
but do not enforce it comprehensively (apart from what the automatic formatter does).
Take particular note of the rules:

- [3.3.1 No wildcard imports](https://google.github.io/styleguide/javaguide.html#s3.3.1-wildcard-imports)
- [5.3 Camel case: defined](https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
(`XmlHttpRequest` and `requestId`, not `XMLHTTPRequest` and `requestID`)

In case of disagreement on code style, defer to the style guide.


Setup for publishing
---

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

```properties
Expand Down

1 comment on commit b670381

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mutation test results

Package Coverage Stats Prev Prev
Overall 81 % 🔹 1365 🔺 / 1669 🔹 81 % 1364 / 1669
com.yubico.fido.metadata 68 % 🔹 220 🔹 / 323 🔹 68 % 220 / 323
com.yubico.internal.util 46 % 🔹 57 🔹 / 123 🔹 46 % 57 / 123
com.yubico.webauthn 88 % 🔹 647 🔹 / 733 🔹 88 % 647 / 733
com.yubico.webauthn.attestation 92 % 🔹 13 🔹 / 14 🔹 92 % 13 / 14
com.yubico.webauthn.data 93 % 🔹 403 🔺 / 429 🔹 93 % 402 / 429
com.yubico.webauthn.extension.appid 100 % 🏆 13 🔹 / 13 🔹 100 % 13 / 13
com.yubico.webauthn.extension.uvm 50 % 🔹 12 🔹 / 24 🔹 50 % 12 / 24
com.yubico.webauthn.meta 0 % 🔹 0 🔹 / 10 🔹 0 % 0 / 10

Previous run: 563e5c3 - Diff

Detailed reports: workflow run #274

Please sign in to comment.