Skip to content

Module Development Checklist

Tomas Langer edited this page Apr 22, 2021 · 1 revision

The following list contains tasks that should be done for each Helidon module:

Before the module is implemented

  • One pager in docs-internal

Implementation

  • Add module to bom/pom.xml
  • Version manage all third party dependencies used by users in dependencies/pom.xml
  • Version manage all other third party dependencies in pom.xml
  • Add an example to examples for new features
  • Update documentation
  • Documentation - do not forget guides using modified module
  • Make sure module can be built using native-image (example in examples should be buildable; contact Tomas L. if in trouble)
  • Update native image documentation under docs (MP and/or SE)
  • Add module (or update it) in FeatureCatalog - native, experimental
  • Add module-info.java

Integration with common features (if applicable)

  • Metrics
  • Tracing
  • Health Checks
  • Security (inbound/outbound)