Bare Minimum GitHub repo - Java Maven Edition

Minimum quality guidelines for maintainable GitHub projects, with Java Maven-specific examples and configurations.

This is the Java Maven edition of the bare-minimum-github-repo project, featuring:

Note

🌍 Universal principles

While this guide focuses on Java Maven projects, the core quality principles apply to any software project.

Requirements

Quickstart

Just run the project with :

mvn clean install

Maven will build and run tests, on test case will output :

My sample title XML


| Name | Surname | Title  |
|---------------|---------------|---------------|
| Luthien | Tinuviel | Queen  |
| Thorin | Oakshield | King  |

To modify the sample template edit :

document.ftl

To modify the sample junit edit :

DocHelperTest.java

Refer to Venus Fugerit Doc Guide to explore full framework potential.

Appendix A : Creation command

This is a sample project configured using fj-doc-maven-plugin init plugin.

This project was created with the command :

mvn org.fugerit.java:fj-doc-maven-plugin:init \
-DgroupId=org.fugerit.java.demo \
-DartifactId=bare-minimum-github-repo-java-maven