/
New modules introduction checklist

New modules introduction checklist

Mar 01, 2024

Checklist

  1. Make sure that new module is compliant with FOLIO Module Acceptance Values and Criteria

  2. Get approval from Product council and  Technical Council

  3. Get new Jira project with project name = module name

  4. Create new repository at https://github.com/folio-org (Follow Guidelines documentation)

  5. Include information regarding module to FOLIO Module/JIRA project-Team-PO-Dev Lead responsibility matrix page

  6. Add module to hosting reference environments (Follow Guidelines documentation)

  7. Align module representation with release plan. Make sure that all deadlines are met. If not, defer module release to next release.

  8. Make module prerelease according to prerelease deadline

  9. Prepare all development documentation required to module deployment (see Information needed for module deployment)

  10. Prepare test cases for module at Folio TestRail

Information needed for module deployment

Deployment Information and any additional dependencies(kafka, ES, minIO) should be specified in the launch descriptor including memory requirements for the module
Deployment teams should not have to go to application.properties file to look for supported java options - maybe they can be specified in launch descriptor also
Any additional configuration should be documented in README
If the module needs any specific permissions, those should be documented also - should not have to figure out from logs/errors
Smoke tests for the module to verify deployment should be specified in ReadMe if applicable
Specify information related to multitenancy compliance at ReadMe