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

Add @author rule in checkstyle #2317

Closed
htynkn opened this issue Aug 18, 2018 · 7 comments
Closed

Add @author rule in checkstyle #2317

htynkn opened this issue Aug 18, 2018 · 7 comments

Comments

@htynkn
Copy link
Member

htynkn commented Aug 18, 2018

According to code-conventions, "@ author" tag is not allow in source code.

I notice some PR and some test code still have "@ author" tag, considering we already have checkstyle plugin, I suggest add a new rule to check @ author tag. it can save time to review PR.

Some configuration sample:
https://github.com/danielb987/EmojicodeEditor/blob/master/checkstyle/emojicode_checks.xml#L93

@carryxyh
Copy link
Member

Agree with this proposal.
I think:

  1. We should check and remove present author tag.
  2. The same thing should be done in branch 2.6.x.
    :)

@htynkn
Copy link
Member Author

htynkn commented Aug 19, 2018

I notice the checkstyle is skip since 81c3c0d
so currently in travis ci, the checkstyle plugin is not running

@kimmking
Copy link
Member

@htynkn
I think we should post this proposal to mail list.

@diecui1202
Copy link

@htynkn I suggest running checkstyle and rat plugin during release phase. For daily travis ci, just running mvn test, it needs to be completed ASAP.

Now the ci task takes a bit long time.

@markt-asf
Copy link

An approach I have seen taken in other projects is to remove @author tags but move the names to the appropriate POM section (if they are not already present).

@diecui1202
Copy link

I've enabled checkstyle and rat plugin for default travis CI.

@diecui1202
Copy link

#2393

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants