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

[#1005] Move checkstyle to root pom.xml #1012

Closed

Conversation

EdgarRamirezFuentes
Copy link
Contributor

@EdgarRamirezFuentes EdgarRamirezFuentes commented Jul 17, 2023

Move the checkstyle plugin from integration-tests/jakarta-ee [shiro-its-jakarta-ee]/pom.xml to the root pom.xml
fixes #1005

When running the command mvn verify to make the basic checks run, it fails when it starts audit in org.apache.shiro:shiro-lang.

Audit result Audit result
Some audit errors Audit result
Build failure Audit result

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a GitHub issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [#XXX] - Fixes bug in SessionManager,
    where you replace #XXX with the appropriate GitHub issue. Best practice
    is to use the GitHub issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • add fixes #XXX if merging the PR should close a related issue.
  • Run mvn verify to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • If you have a group of commits related to the same change, please squash your commits into one and force push your branch using git rebase -i.
  • Committers: Make sure a milestone is set on the PR

Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
In this case, just format the pull request title like [DOC] - Add javadoc in SessionManager.

If this is your first contribution, you have to read the Contribution Guidelines

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement
if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

Move the checkstyle plugin from integration-tests/jakarta-ee [shiro-its-jakarta-ee]/pom.xml to the root pom.xml
@lprimak
Copy link
Contributor

lprimak commented Jul 17, 2023

Couple of comments:

  • Can you please make your PR draft until it's ready?

Here is the order of preference / priority for type of checkstyle-related fixes:

  • Fix the code itself to conform to checkstyle
  • Use @SuppressWarnings to ignore error
  • Add a line to suppressions.xml

@lprimak
Copy link
Contributor

lprimak commented Jul 17, 2023

I would say for MagicNumber, @SuppressWarnings is the right thing to do

@EdgarRamirezFuentes EdgarRamirezFuentes marked this pull request as draft July 19, 2023 15:14
@lprimak lprimak added java Pull requests that update Java code CLA core Core Modules labels Aug 4, 2023
@lprimak
Copy link
Contributor

lprimak commented Oct 3, 2023

Superseded by #1069

@lprimak lprimak closed this Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA core Core Modules java Pull requests that update Java code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expand checkstyle to all modules (root)
2 participants