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

Peer Review for Linux #5

Open
19 tasks
gkwan-ibm opened this issue Oct 30, 2024 · 0 comments
Open
19 tasks

Peer Review for Linux #5

gkwan-ibm opened this issue Oct 30, 2024 · 0 comments

Comments

@gkwan-ibm
Copy link
Member

gkwan-ibm commented Oct 30, 2024 •
edited
Loading

Review and test this guide by a peer member with the following prespectives

  • by Firefox

README

  • Check the appearance of the guide:
    • Table of contents
    • Headings
    • Paragraphs
    • code snippets
    • outputs
    • links (shoud open a new tab)
    • hotspots (should highlight the code correctly)
  • Check that the pom.xml, server.xml, and java files etc files are clean on the right code pane
    • lines are not too long and wrapped
    • lines are aligned nicely
  • Examples with the right outcomes are provided

pom.xml

  • Check that the dependencies and plugins are latest in all of the pom.xml files:
    • jakarta.jakartaee-api
    • microprofile
    • liberty-maven-plugin
    • etc.

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 the directories are properly structured

Additional tests:

  • Test the guide end-to-end with working instruction and sample code with either of the following Java
    • Java 17
  • Perform all the defined test cases
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
1 participant
@gkwan-ibm