[ ] Check that the dependencies and plugins are latest in all of the pom.xml files:
jakarta.jakartaee-api
microprofile
liberty-maven-plugin
etc.
[ ] Check that there are 4 spaces per indent for proper formatting
[ ] Check that no tab characters are used
Overall checks:
[ ] Check the consistency of guide with the template and other guides
[ ] Check the quality of code according to the best coding practices
[ ] Check that all licensing statements are properly stated in all files, with the correct year (Should be present in all Java files + the index.html)
[ ] Check that the directories are properly structured
[ ] Check that some of these page-tags are used in a guide: MicroProfile, Maven, Docker, Kubernetes, Gradle, Jakarta EE, Security, Cloud. Only these tags are visible on the website. Latest list here.
[ ] Check the attribution statement is accurate for the guide
[ ] Verify the GitHub Actions scripts, if any, are accurate and consistent with other guides
Additional tests:
[ ] tests where applicable:
[ ] Define test coverage and review with team (including guide contributor, if available)
[ ] Define detail test cases
[ ] Consider corner cases targeting the specific guide
[ ] Consider corner cases UI tests
[ ] Consider testing the curl command for localhost URLs
[ ] Make sure the index.html information is correct by visiting the root, e.g. http://localhost:9080
[ ] Testing with different IDEs, ie, Atom, Eclipse (Optional: VS.code, IntelliJ, Microclimate)
import the finish directory and see any complication error, unused import packages, etc
[ ] Consider SEO title and description for the guides
[ ] Ensure automated tests with GitHub Actions are enabled
[ ] Run diff -r start/ finish/ and there is no differences expect tag and end comments
[ ] Ensure that the automation tests are able to run when PR is created
[ ] Test the guide end-to-end with working instruction and sample code with either of the following Java
Review and test this guide by a peer member with the following prespectives
by Chrome
README
$(cmd)format and not`cmd`[INFO]tabpom.xml,server.xml, and java files etc files are clean on the right code pane[ ] Run Acrolinx Checker (above 70 score approximately)
pom.xmlpom.xmlfiles:[ ] Check that no tab characters are used
Overall checks:
index.html)page-tagsare used in a guide:MicroProfile, Maven, Docker, Kubernetes, Gradle, Jakarta EE, Security, Cloud. Only these tags are visible on the website. Latest list here.attributionstatement is accurate for the guide[ ] Verify the GitHub Actions scripts, if any, are accurate and consistent with other guides
Additional tests:
curlcommand for localhost URLsindex.htmlinformation is correct by visiting the root, e.g.http://localhost:9080diff -r start/ finish/and there is no differences expecttagandendcomments