You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Liberty plugin -->
<plugin>
<groupId>io.openliberty.tools</groupId>
<artifactId>liberty-maven-plugin</artifactId>
<version>3.2</version>
</plugin>
Check that there are 4 spaces per indent for proper formatting
Ensure that the guide is using the latest version of the liberty-maven-plugin or liberty-gradle-plugin where applicable
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, Java 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 travisTest.sh script, if any, is accurate and consistent with other guides
Additional 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 URL on all browsers, ie, FF, Chrome, Safari
Consider testing the curl command for URL visits
Consider building with both Maven and Gradle build tools
Testing with different IDEs, ie, Atom, Eclipse (Optional: VS.code, IntelliJ, Microclimate)
Run Acrolinx Checker on draft (above 70 score approximately)
Consider SEO title and description for the guides
Ensure automated test is enable, set up with Travis CI, and able to schedule tests
Run diff -r start/ finish/ and there's no differences
Ensure that the automation tests are able to run when PR is created
Check the appearance of the guide on test site for the following items:
Table of contents
Headings
Paragraphs
code snippets
outputs
links
hotspots
Test the guide end-to-end with working instruction and sample code
Perform all the defined test cases
The text was updated successfully, but these errors were encountered:
Peer Review conducted on 3 platforms: Mac, Windows & Linux
Peer Review: review to be done by a peer member.
Functionality
curl
command where applicableFormatting & Presentation
README.adoc
checks:$(cmd)
format and not`cmd`
[INFO]
tabpom.xml
checks (if files are present):pom.xml
files:liberty-maven-plugin
orliberty-gradle-plugin
where applicableOverall checks:
index.html
)page-tags
are used in a guide:MicroProfile, Maven, Docker, Kubernetes, Gradle, Java EE, Security, Cloud
. Only these tags are visible on the website. Latest list here.attribution
statement is accurate for the guidetravisTest.sh
script, if any, is accurate and consistent with other guidescurl
command for URL visitsdiff -r start/ finish/
and there's no differencesThe text was updated successfully, but these errors were encountered: