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.

Sign up for GitHub

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

Jump to bottom

Enforce CONTRIBUTING rules with ArchUnit #2924

Open
pivovarit opened this issue Oct 28, 2024 · 1 comment
Open

Enforce CONTRIBUTING rules with ArchUnit #2924

pivovarit opened this issue Oct 28, 2024 · 1 comment

Comments

@pivovarit
Copy link
Member

At the moment, contributing rules are paper-based with protein-based verification and enforcement - https://github.com/vavr-io/vavr/blob/master/CONTRIBUTING.md

We could enforce those using https://www.archunit.org
@bvkatwijk bvkatwijk mentioned this issue Dec 30, 2024
Merged
pivovarit pushed a commit that referenced this issue Dec 30, 2024
@bvkatwijk
Enforce package depth with ArchUnit (#2952)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
Loading
Loading status checks…
f8bfe52 
- Enforce package depth using ArchUnit test

CONTRIBUTING.md mentions:
> The maximum package depth is two

Violation results in a unit test failure:
> Architecture Violation [Priority: MEDIUM] - Rule 'classes should have
a package depth of 3 or less' was violated (1 times):
Class io.vavr.too.deep.SomeClass has a package depth of 4, which exceeds
the allowed maximum of 3

Small step in fixing issue #2924
@bvkatwijk bvkatwijk mentioned this issue Jan 1, 2025
Closed
@bvkatwijk
Copy link
Contributor

I think that ArchUnit does not support checking Javadoc.
An option for checking those rules could be CheckStyle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pivovarit @bvkatwijk