Skip to content

Commit

Permalink
Document style guide and google-java-format in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Prompted by discussion on this commit: google/ExoPlayer@e811749

#minor-release

PiperOrigin-RevId: 524795901
  • Loading branch information
icbaker authored and rohitjoins committed Apr 17, 2023
1 parent 6f89ddf commit f799766
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,21 @@ We will also consider high quality pull requests. These should merge
into the `main` branch. Before a pull request can be accepted you must submit
a Contributor License Agreement, as described below.

### Code style

We follow the
[Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)
and use [`google-java-format`](https://github.com/google/google-java-format) to
automatically reformat the code. Please consider auto-formatting your changes
before opening a PR (we will otherwise do this ourselves before merging). You
can use the various IDE integrations available, or bulk-reformat all the changes
you made on top of `main` using
[`google-java-format-diff.py`](https://github.com/google/google-java-format/blob/master/scripts/google-java-format-diff.py):

```shell
$ git diff -U0 main... | google-java-format-diff.py -p1 -i
```

## Contributor license agreement

Contributions to any Google project must be accompanied by a Contributor
Expand Down

0 comments on commit f799766

Please sign in to comment.