palantir / palantir/palantir-java-format
docs: clarify how this compares to `google-java-format`
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 907
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
In the README, there are some before/after examples, but it isn't clear whether that's comparing this library to the google version, or just to unformatted code.
It'd be great to see diffs between the two, and/or have a list of improvements you've made over the google one.
FWIW, my impression is:
- This uses 4 spaces instead of 2.
- This has much better style for builders.
I'd like to see this library become more popular!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the README, where the existing before/after examples are described. Compare the documented formatter behavior with google-java-format and determine whether the examples are against unformatted code or the Google formatter. Done means the README clearly explains the comparison and documents the relevant improvements, such as spacing or builder formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100