apache / apache/pulsar

[Docs] Need to add suppressions instruction to readme for configuring IntelliJ checkstyle rules

Open
#13,631 3 comments 0 reactions 0 assignees View on GitHub
lifecycle/stale Stale type/enhancement
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 14h
Merged PRs (30d)
160

Description

On the main Pulsar Github readme, in the section of configuring Checkstyle rules in IntelliJ (https://github.com/apache/pulsar#configure-checkstyle)

I noticed that there's a suppressions.xml file in the same directory as the checkstyle.xml file:
![image](https://user-images.githubusercontent.com/7418031/148278249-17d53c22-26a0-48b2-af72-1fde6d4a8cf9.png)

After following the instructions to select the checkstyle.xml file, this additional dialog box opens:
![image](https://user-images.githubusercontent.com/7418031/148278383-982c76cd-cd1c-4e98-924c-ccfc358b44ac.png)

Should we be providing the path to the suppressions.xml file as the value in that box? If so, is that an absolute or a relative path?
Additional instructions on this would be helpful.

Contributor guide

Open the contributing guide

Research direction

Open the main README at the Configure Checkstyle rules in IntelliJ section and inspect the instructions around checkstyle.xml. Review the accompanying suppressions.xml file and determine the path format IntelliJ expects for the additional dialog. Update the README with the suppressions guidance and verify that the setup steps are complete.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.