smengcl commented on code in PR #188: URL: https://github.com/apache/ozone-site/pull/188#discussion_r3647465945
########## docs/08-developer-guide/04-project/03-ozone-enhancement-proposals.md: ########## @@ -0,0 +1,102 @@ +--- +sidebar_label: Ozone Enhancement Proposals +--- + +# Ozone Enhancement Proposals + +For large features or changes, we use a process called "Ozone Enhancement Proposals" (OEPs) +to ensure that major modifications to Ozone are well-designed and have community consensus. + +If you plan to propose a significant change, please follow the process below +and create a design document *before* you start coding. + +**Note:** Design documents must be in Markdown format. We no longer accept PDFs or Google Docs. + +## OEP Process + +1. **Create a Jira:** Open a dedicated Jira ticket for the proposal. The ticket ID should start with the component prefix (e.g., `HDDS-`) and the title should be prefixed with `[OEP]`. +2. **Write the Design Doc:** Create the design document in Markdown format using the template below. Place the new file in the `hadoop-hdds/docs/content/design` directory. +3. **Submit a Pull Request:** Create a pull request to add the design document to the documentation. Review Comment: ```suggestion 3. **Submit a Pull Request:** Create a pull request to add the design document to the documentation. Add label `design` to the pull request. ``` -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
