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

[java] Provide example rulesets for customized naming conventions #2285

Open
adangel opened this issue Feb 13, 2020 · 2 comments
Open

[java] Provide example rulesets for customized naming conventions #2285

adangel opened this issue Feb 13, 2020 · 2 comments
Labels
a:suggestion An idea, with little analysis on feasibility, to be considered

Comments

@adangel
Copy link
Member

adangel commented Feb 13, 2020

Description:

Similar quickstart.xml, we could provide naming convention rulesets, preconfigured with different defaults:

This could be extended for other languages as well.

While the rules are configurable, it might not be so easy to adjust the rules without having examples.
See also #2266 .

@adangel adangel added the a:suggestion An idea, with little analysis on feasibility, to be considered label Feb 13, 2020
@oowekyala
Copy link
Member

I think we could add an "example config" element to document rules, which would scale better than exposing and maintaining new rules references. Checkstyle does this very well, eg https://checkstyle.org/config_header.html#Header_Examples

@adangel
Copy link
Member Author

adangel commented Feb 17, 2020

Good idea!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:suggestion An idea, with little analysis on feasibility, to be considered
Projects
None yet
Development

No branches or pull requests

2 participants