Skip to content

Policy for adding new modules #1503

@rnorth

Description

@rnorth

We often receive proposals (or fully formed PRs) for new modules, but don't have a clear policy on whether to accept them or not.

In the past we have accepted a small number of modules that have caused us significant maintenance headaches long after the contributor has gone away, and I'd like to avoid this in future. Equally, we'd like to encourage useful modules to be contributed!

We should have a policy in our documentation that:

  • Describes our criteria for 'what kinds of module we would accept', so that people can work out whether to expend effort on a contribution.

  • Provides a checklist for things we look for in a module PR (e.g. mainstream appeal, reliability and licensing for required docker images, docs, etc)

  • Sets out a process for gently onboarding a new module into the official modules 'ecosystem' - e.g. ensuring stability of tests in our CI, scope for user feedback that may change the public API, etc. My initial thought is some kind of beta/incubator label for new modules.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions