Skip to content

Maintenance: Checkstyle improvements #1345

Open
@scottgerring

Description

@scottgerring

Summary

Checkstyle's great, but we should make it easier to work with.

Why is this needed?

If contributors can't easily push changes because of checkstyle lints we are raising the barrier to entry to contribution.

Which area does this relate to?

No response

Solution

  • some way of CLI-applying lints - so we’re not tied to intellij, and so we can use that in the build if needed
  • fail the build if lints aren’t applied - as it stands, some lints do this, but not all of the formatting changes checkstyle applies. If we want to enforce the formatting, we should fail if it is not there
  • enforce javadoc on public interfaces putting Checkstyle in place lets us ensure other nice properties of the codebase hold - like full coverage of public interface documentation

I'm not sure how far we can get with the checkstyle plugin for these points, but would expect there is some solution out there!

Acknowledgment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions