palantir / palantir/palantir-java-format

README.md -> IntelliJ plugin section has wrong paths to the IDE menu

Open
#1,023 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
907
Forks
101
Avg merge
1d 3h
Merged PRs (30d)
19

Description

What happened?

README.md -> IntelliJ plugin section has wrong paths to the menu.

At the very least, for Macbook, it should be:

To manually enable it in the current project, go to IntelliJ IDEA -> Settings ... -> palantir-java-format Settings, and enable the Enable palantir-java-format checkbox.

To enable it by default in new projects, use File -> New Projects Setup -> Settings for New Projects ... -> Other Settings -> palantir-java-format Settings, and enable the Enable palantir-java-format checkbox.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open README.md and find the IntelliJ plugin section. Compare its menu paths with the Mac paths described in the issue, update the documented paths and checkbox wording, and verify that both manual project setup and new-project setup are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.