github.com/kubewharf/katalyst-core@v0.5.3/docs/proposals/YYYYMMDD-template.md (about) 1 --- 2 title: Proposal Template 3 authors: 4 - "@XXX" 5 reviewers: 6 - "@YYY" 7 creation-date: yyyy-mm-dd 8 last-updated: yyyy-mm-dd 9 status: provisional|experimental|implementable|implemented|deferred|rejected|withdrawn|replaced 10 see-also: 11 - "/docs/proposals/20190101-we-heard-you-like-proposals.md" 12 - "/docs/proposals/20190102-everyone-gets-a-proposal.md" 13 replaces: 14 - "/docs/proposals/20181231-replaced-proposal.md" 15 superseded-by: 16 - "/docs/proposals/20190104-superceding-proposal.md" 17 --- 18 19 # Title 20 21 - Keep it simple and descriptive. 22 - A good title can help communicate what the proposal is and should be considered as part of any review. 23 24 <!-- BEGIN Remove before PR --> 25 To get started with this template: 26 1. **Make a copy of this template.** 27 Copy this template into `docs/proposals` and name it `YYYYMMDD-my-title.md`, where `YYYYMMDD` is the date the proposal was first drafted. 28 1. **Fill out the required sections.** 29 1. **Create a PR.** 30 Aim for single topic PRs to keep discussions focused. 31 If you disagree with what is already in a document, open a new PR with suggested changes. 32 33 The canonical place for the latest set of instructions (and the likely source of this file) is [here](./YYYYMMDD-template.md). 34 35 The `Metadata` section above is intended to support the creation of tooling around the proposal process. 36 This will be a YAML section that is fenced as a code block. 37 See the proposal process for details on each of these items. 38 39 <!-- END Remove before PR --> 40 41 ## Table of Contents 42 43 A table of contents is helpful for quickly jumping to sections of a proposal and for highlighting 44 any additional information provided beyond the standard proposal template. 45 [Tools for generating](https://github.com/ekalinin/github-markdown-toc) a table of contents from markdown are available. 46 47 - [Title](#title) 48 - [Table of Contents](#table-of-contents) 49 - [Summary](#summary) 50 - [Motivation](#motivation) 51 - [Goals](#goals) 52 - [Non-Goals/Future Work](#non-goalsfuture-work) 53 - [Proposal](#proposal) 54 - [User Stories](#user-stories) 55 - [Story 1](#story-1) 56 - [Story 2](#story-2) 57 - [Requirements [Optional]](#requirements-optional) 58 - [Functional Requirements](#functional-requirements) 59 - [FR1](#fr1) 60 - [FR2](#fr2) 61 - [Non-Functional Requirements](#non-functional-requirements) 62 - [NFR1](#nfr1) 63 - [NFR2](#nfr2) 64 - [Design Overview [Optional]](#design-overview-optional) 65 - [API [Optional]](#api-optional) 66 - [Design Details](#design-details) 67 - [Non-Functional Design [Optional]](#non-functional-design-optional) 68 - [Alternatives](#alternatives) 69 - [Additional Details](#additional-details) 70 - [Test Plan [optional]](#test-plan-optional) 71 - [Implementation History](#implementation-history) 72 73 ## Summary 74 75 The `Summary` section is incredibly important for producing high quality user-focused documentation such as release notes or a development roadmap. 76 It should be possible to collect this information before implementation begins in order to avoid requiring implementors to split their attention between writing release notes and implementing the feature itself. 77 78 A good summary is probably at least a paragraph in length. 79 80 ## Motivation 81 82 This section is for explicitly listing the motivation, goals and non-goals of this proposal. 83 84 - Describe why the change is important and the benefits to users. 85 - The motivation section can optionally provide links to [experience reports](https://github.com/golang/go/wiki/ExperienceReports) 86 to demonstrate the interest in a proposal within the wider Katalyst community. 87 88 ### Goals 89 90 - List the specific high-level goals of the proposal. 91 - How will we know that this has succeeded? 92 93 ### Non-Goals/Future Work 94 95 - What high-levels are out of scope for this proposal? 96 - Listing non-goals helps to focus discussion and make progress. 97 98 ## Proposal 99 100 This is where we get down to the nitty gritty of what the proposal actually is. 101 102 - What is the plan for implementing this feature? 103 - What data model changes, additions, or removals are required? 104 - Provide a scenario, or example. 105 - Use diagrams to communicate concepts, flows of execution, and states. 106 107 [PlantUML](http://plantuml.com) is the preferred tool to generate diagrams, 108 place your `.plantuml` files under `images/` and run `make diagrams` from the docs folder. 109 110 ### User Stories 111 112 - Detail the things that people will be able to do if this proposal is implemented. 113 - Include as much detail as possible so that people can understand the "how" of the system. 114 - The goal here is to make this feel real for users without getting bogged down. 115 116 #### Story 1 117 118 #### Story 2 119 120 ### Requirements [Optional] 121 122 Some authors may wish to use requirements in addition to user stories. 123 Technical requirements should be derived from user stories, and provide a trace from 124 use case to design, implementation and test case. Requirements can be prioritised 125 using the MoSCoW (MUST, SHOULD, COULD, WON'T) criteria. 126 127 The difference between goals and requirements is that between an executive summary 128 and the body of a document. Each requirement should be in support of a goal, 129 but narrowly scoped in a way that is verifiable or ideally - testable. 130 131 #### Functional Requirements 132 133 Functional requirements are the properties that this design should include. 134 135 ##### FR1 136 137 ##### FR2 138 139 #### Non-Functional Requirements 140 141 Non-functional requirements are user expectations of the solution. Include 142 considerations for performance, reliability and security. 143 144 ##### NFR1 145 146 ##### NFR2 147 148 ### Design Overview [Optional] 149 150 This section is used to describe the overall design of the proposal. For example, 151 152 - The architecture of the system. 153 - What components of the system are relevant to this proposal? 154 - How do these components communicate with each other? 155 156 ### API [Optional] 157 158 This section is used to explain the design related to API. For example, 159 160 - Addition, deletion and modification of CRDs. 161 - Addition, deletion and modification of labels, annotations, and finalizers. 162 - Addition, deletion and modification of resource keys. 163 164 ### Design Details 165 166 - What are some important details that didn't come across above. 167 - What are the caveats to the implementation? 168 - Go in to as much detail as necessary here. 169 - Talk about core concepts and how they relate. 170 171 ## Non-Functional Design [Optional] 172 173 This section is used to describe non-functional design. For example, 174 175 - Performance 176 - Observability 177 - Scalability 178 - Extensibility 179 - Upgrade strategy 180 - Risks and mitigations 181 182 ## Alternatives 183 184 The `Alternatives` section is used to highlight and record other possible approaches to delivering the value proposed by a proposal. 185 186 ## Additional Details 187 188 ### Test Plan [optional] 189 190 **Note:** *Section not required until targeted at a release.* 191 192 Consider the following in developing a test plan for this proposal: 193 - Will there be e2e and integration tests, in addition to unit tests? 194 - How will it be tested in isolation vs with other components? 195 196 No need to outline all of the test cases, just the general strategy. 197 Anything that would count as tricky in the implementation and anything particularly challenging to test should be called out. 198 199 ## Implementation History 200 201 - [ ] MM/DD/YYYY: Proposed idea in an issue or community meeting 202 - [ ] MM/DD/YYYY: Compile a document following the proposal template (link here) 203 - [ ] MM/DD/YYYY: First round of feedback from community 204 - [ ] MM/DD/YYYY: Present proposal at a community meeting 205 - [ ] MM/DD/YYYY: Open proposal PR