Ensure a LICENSE file is present in the project and picked up by GitHub UI on the main repository page (right column below “About”). While at it, ensure the license is specified in the pom.xml as well.

Examples:

https://github.com/wildfly/wildfly/blob/main/LICENSE.txt

https://github.com/modcluster/mod_cluster/blob/main/LICENSE.txt

Activity

Ensure a LICENSE file is present and properly picked up by GitHub and defined in a pom. If it isn’t, open a pull request to remedy the situation. Update the spreadsheet with the status.

This file explains what the project does, including basic usage and minimal configuration, link to documentation and link to an issue tracker, etc. This might also include the building instructions if not part of the contributing guide (below).

This file is often the item a visitor will see when visiting the repository as GitHub shows this file to repository visitors.

Examples:

https://github.com/wildfly/wildfly/blob/main/README.md

https://github.com/wildfly-security/wildfly-elytron/blob/1.x/README.md

Activity

Create/update/verify README file is present and properly picked up by GitHub. If it isn’t, open a pull request to remedy the situation. Update the spreadsheet with the status.

link to document: https://docs.google.com/document/d/1dbOk4eorV4LQGNrhNVB1bLyiowGBkhdf5o3bLNEfVJY