asafm opened a new pull request, #19832: URL: https://github.com/apache/pulsar/pull/19832
### Motivation & Modifications As [discussed](https://lists.apache.org/thread/jpbnc1p2vsmlx81t0fllsk3fp84od5ny) in the mailing list, the PIP issue template has several drawbacks. I'm now quoting the opening mail in the thread. I would like to suggest two changes I'd like to make to the PIP design template: 1. Remove the form - just have a markdown template fill the issue body as it is created. 2. Change the PIP template structure == Removing the form Today, when you want to submit a PIP, you are required to fill out a form with boxes composed of 3-4 lines length. It's not good because: * It broadcasts to the author: we want a very small PIP, something that fits those small boxes. * It makes the PIP look like a bug, where you fill out fields. * It doesn't allow having H2 headings, only H1 headings, thus limiting the structure. A PIP is a design, essentially, something 1–3 pages long. Thus, people take the time to write it down. Preferably, they copy and paste the body of the PIP issue, and use it to fill in sections. My suggestion is to define an issue template using only Markdown, without a form. == Changing PIP Structure Today the structure of the PIP doc (pasted below), is missing a section and generally aims to jump directly into API changes / code / implementation. This results in lots of back and forth emails in an attempt to get the following essentials: * All required background knowledge to understand the proposal * A high level overview of the proposed solution * Understanding how this proposal will be monitored * What steps exactly I need to take if I revert to the previous version. The structure I propose in this PR aims to reduce that friction and get all PIP aligned to provide that information. ### Verifying this change - [ ] Make sure that the change passes the CI checks. This change is a trivial rework / code cleanup without any test coverage. ### Does this pull request potentially affect one of the following parts: <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. --> *If the box was checked, please highlight the changes* - [ ] Dependencies (add or upgrade a dependency) - [ ] The public API - [ ] The schema - [ ] The default values of configurations - [ ] The threading model - [ ] The binary protocol - [ ] The REST endpoints - [ ] The admin CLI options - [ ] The metrics - [ ] Anything that affects deployment ### Documentation <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. --> - [ ] `doc` <!-- Your PR contains doc changes. --> - [ ] `doc-required` <!-- Your PR changes impact docs and you will update later --> - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs --> - [ ] `doc-complete` <!-- Docs have been already added --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
