Development¶
CADDForge development should preserve the split between core runtime behavior and tool-specific science.
Rules of thumb¶
- Keep core independent of specific scientific tools.
- Register tools as plugins instead of hardcoding them in core.
- Use typed, validated config models.
- Use shared job, registry, metadata, and result helpers.
- Keep pipeline stages generic unless the behavior belongs in a plugin.
- Add focused tests for config validation, artifact contracts, scatter behavior, and result loading.
Contribute and maintain¶
- Release notes: changes in each documentation package release.
- Contributing: setup, review, support, and community expectations.
- Documentation: authoring, explicit API generation, examples, and validation.
- Security reporting: confidential reports and deployment boundaries.
- Release checklist: licensing, public content, history, and package availability.