Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ORC-982: Extract checkstyle to a single file, help newcomers check code style #895

Merged
merged 4 commits into from
Sep 3, 2021

Conversation

guiyanakuang
Copy link
Member

What changes were proposed in this pull request?

Extract checkstyle to a single file.
Added tips to coding.md.

Why are the changes needed?

CheckStyle-IDEA plugin is very simple to load this checkstyle.xml. This way you get checkstyle errors/warnings already when you are coding.
image

How was this patch tested?

Pass the CIs.

"https://checkstyle.org/dtds/configuration_1_2.dtd">

<module name="Checker">
<module name="FileTabCharacter">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we use two-space indentation?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My IDE's config for xml indentation defaults to 4 spaces. I'll fix this later.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix in ec7c471.

@dongjoon-hyun
Copy link
Member

cc @williamhyun

limitations under the License.
-->
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.2//EN"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto. This needs 4 spaces instead of 8 spaces.

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, LGTM. Merged to main.
Thank you, @guiyanakuang .

@dongjoon-hyun dongjoon-hyun merged commit 796b8ca into apache:main Sep 3, 2021
@guiyanakuang
Copy link
Member Author

Thank you very much @dongjoon-hyun, thank to review and fix format.

@dongjoon-hyun dongjoon-hyun added this to the 1.8.0 milestone Apr 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants