diff --git a/teps/NNNN-tep-template/README.md b/teps/NNNN-tep-template/README.md new file mode 100644 index 000000000..4cd35d1bd --- /dev/null +++ b/teps/NNNN-tep-template/README.md @@ -0,0 +1,225 @@ + +# TEP-NNNN: Your short, descriptive title + + + + + + +- [Summary](#summary) +- [Motivation](#motivation) + - [Goals](#goals) + - [Non-Goals](#non-goals) +- [Proposal](#proposal) + - [User Stories (optional)](#user-stories-optional) + - [Story 1](#story-1) + - [Story 2](#story-2) + - [Notes/Constraints/Caveats (optional)](#notesconstraintscaveats-optional) + - [Risks and Mitigations](#risks-and-mitigations) +- [Design Details](#design-details) + - [Test Plan (optional)](#test-plan-optional) +- [Implementation History](#implementation-history) +- [Drawbacks](#drawbacks) +- [Alternatives](#alternatives) +- [Infrastructure Needed (optional)](#infrastructure-needed-optional) + + +## Summary + + + +## Motivation + + + +### Goals + + + +### Non-Goals + + + +## Proposal + + + +### User Stories (optional) + + + +#### Story 1 + +#### Story 2 + +### Notes/Constraints/Caveats (optional) + + + +### Risks and Mitigations + + + +## Design Details + + + +### Test Plan (optional) + + + +## Implementation History + + + +## Drawbacks + + + +## Alternatives + + + +## Infrastructure Needed (optional) + + diff --git a/teps/README.md b/teps/README.md index d23c7e670..050403743 100644 --- a/teps/README.md +++ b/teps/README.md @@ -39,7 +39,7 @@ Groups](https://github.com/tektoncd/community/blob/master/working-groups.md) This process does not block authors from doing early design docs using any means. It does not block authors from sharing those design docs -with the community (during Working groups, on Slack, GitHub, …**. +with the community (during Working groups, on Slack, GitHub, …. **This process acts as a requirement when a design docs is ready to be implemented or integrated in the `tektoncd` projects**. In other words,