Skip to content

Guide for creating new Science modules #40

@RBhupi

Description

@RBhupi

Documentation type

Missing documentation (topic not covered anywhere)

Type of issue

Missing — this topic is not documented at all

Location

No response

What is wrong or missing?

No Docs on how new modules should be implemented in Adapt.

  • Module lifecycle
  • Required interfaces
  • Configuration integration
  • Input/output contracts
  • Runtime state management
  • Logging conventions
  • Error handling behavior
  • Registration into execution pipelines

Suggested correction or addition

Suggested correction or addition

Create a "Creating a Module" developer guide containing:

  • Base module architecture
  • Required interfaces and contracts
  • Minimal example module
  • Execution lifecycle expectations
  • Configuration integration examples
  • Runtime interaction patterns
  • Testing recommendations
  • Common implementation pitfalls

Include a minimal working example for a small module.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions