Skip to content

Commit a32de3e

Browse files
author
John Watson
authored
Merge pull request #10 from newrelic/jkeller/add-code-style-guidelines
Add code style guidelines
2 parents 241b236 + 938a7fa commit a32de3e

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ Before we can accept a pull request, you must sign our [Contributor Licensing Ag
3737
Minimally, the [test suite](#testing-guidelines) must pass for us to accept a PR. Ideally, we would love it if you also added appropriate tests if you're implementing a feature!
3838

3939
## Coding Style Guidelines
40+
Our code base is formatted according to the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).
41+
42+
The project is configured to use the [google-java-format-gradle-plugin](https://github.com/sherter/google-java-format-gradle-plugin) which can be utilized as follows:
43+
44+
* Execute the task `googleJavaFormat` to format all `*.java` files in the project:
45+
46+
`./gradlew goJF`
47+
48+
* Execute the task `verifyGoogleJavaFormat` to verify that all `*.java` files are formatted properly:
49+
50+
`./gradlew verGJF`
4051

4152
## Testing Guidelines
4253
The AWS Lambda OpenTracing Java SDK comes with tests in `src/test` that can be run with `./gradlew test`.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ public class MyLambdaHandler implements TracingRequestHandler<Map<String, Object
8888
}
8989
```
9090

91-
9291
## Getting Started
9392

9493
### Requirements

0 commit comments

Comments
 (0)