palantir / palantir/palantir-java-format
Provide how-to in README to format code with maven
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 907
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
Hi,
Could you provide a section in README to format code with maven like in project https://github.com/google/google-java-format ?
Thank you
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 with the repository README and compare its formatting instructions with the approach documented in google-java-format. Add a section explaining how to format code through Maven, using only the project’s existing Maven setup and commands. Done means a newcomer can find and follow the README instructions to run formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100