tree: 8c1d5ccb3c58a3ce4cb9be55778c4c5fedd30168 [path history] [tgz]

How to submit a Proposal for an OpenWhisk Enhancement (POEM)

This directory contains Proposals for OpenWhisk Enhancements (POEM). Proposed changes, new features and ideas are documented using a process outlined in this document. If you're a contributor interested in out of the proposals, you are encouraged to reach out to the proposal authors. This is a welcoming community and we look forward to your contributions. This directory contains approved proposals. The one who wants to include any major new feature, subsystem, piece of functionality and any breaking changes is supposed to open a proposal.

You can find the full details in POEM-1.

Quickstart to propose a new change.

  1. Copy the POEM template and open a pull request.
  2. Create a corresponding issue with the prefix, [Proposal] in the title.
  3. Follow the process outlined in the POEM-1.

When should I open a proposal?

Create an issue when you propose:

  • any major new feature, subsystem, or piece of functionality
  • a big change which requires multiple PRs to complete it
  • a breaking change that impacts public interfaces, data structures, or core execution paths.

If you are not sure, ask to committers or the [PMC] of OpenWhisk.

The POEM process was inspired by KEP( Kubernetes Enhancement Proposals), KIP (Kafka Improvement Proposal), and Cordova-discuss.