Back to Openwhisk

Licensed to the Apache Software Foundation (ASF) under one or more

proposals/POEM-N-template.md

2.0.01.9 KB
Original Source
<!-- # # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # -->

This is a template for a filed proposal. Create a pull request using this template.

Title

This is the title of the POEM. A good simple title would help to describe the purpose of a proposal.

Your Poem

Roses are red. Violets are blue. Your ideas are beautiful. We welcome you.

Status

  • Current state: (Draft | In-progress | Completed | Abandoned)
  • Author(s): @author (Github ID)

Summary and Motivation

This section summarize the proposal. A brief description, proposed changes, and effects are expected to be included. You should cover the "what" and the "why" and briefly the "how".

Proposed changes: Architecture Diagram (optional), and Design

This section may include large subsections, diagrams, links to references, and so on.

It is recommended to include an architectural diagram. A link to an external resource is enough.

Implementation details

This section describe how to implement the proposal.

Issue (optional)

Any issue(compatibility, drawbacks, etc) should be describe here.

Integration and Migration plan (optional)

If a proposal contains any breaking changes, it is required to include a plan for integration and migration.