docs: add community examples section to README - #1692
Open
vijayagopalsb wants to merge 1 commit into
Open
Conversation
Adds a link to the devonfw-sample/archunit project as a community example for best practices with ArchUnit. Relates-to: TNG#1095
Author
|
I agree to the DCO for this contribution. Signed-off-by: Vijayagopal SB vijayagopal.sb@gmail.com |
This was referenced Aug 8, 2026
hankem
reviewed
Aug 9, 2026
Comment on lines
+57
to
67
| ## Community Examples | ||
|
|
||
| The following projects provide additional examples and best practices for using ArchUnit in real-world applications: | ||
|
|
||
| - [devonfw-sample/archunit](https://github.com/devonfw-sample/archunit) — A complete layered architecture demo with well-crafted ArchUnit tests and a CI workflow demonstrating violation reporting. | ||
|
|
||
| ## Where to look next | ||
|
|
||
| For further information, check out the user guide at [https://archunit.org](https://archunit.org) | ||
| or test examples for the current release at | ||
| [ArchUnit Examples](https://github.com/TNG/ArchUnit-Examples). |
Member
There was a problem hiding this comment.
Thanks for your contribution!
Three thoughts about it:
- For the DCO check to pass, you need to amend your git commit and add the line from your comment there, see also DCO.
- I think community examples should be mentioned after the
Where to look nextsection with the user guide and the "official" ArchUnit Examples. - While I'm not opposed to linking community examples in general, I'm not specifically convinced either. I don't want to offend anybody who created devonfw-sample/archunit; it was a nice example when it was created! I just wonder what is so special about it that's "worth" the direct link (and not just be discovered via search engines like other good examples and blog posts on the internet):
- It's a Maven project using ArchUnit 1.0.1 (released on 2022 Nov 21), illustrating the integration with JUnit5. It basically hasn't been updated for 3 years.
- TNG/ArchUnit-Examples, on the other hand, contain Gradle and Maven examples for plain ArchUnit as well as its integration with JUnit 4 / 5 / 6; they're guaranteed to work as they're derived from ArchUnit's own build, and automatically updated with every release. If an example was missing, shouldn't we rather add it there?
hankem
added
the
question
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a link to the devonfw-sample/archunit project as a community example for best practices with ArchUnit.
Relates-to: #1095