add the proposal template file
This commit is contained in:
52
proposal/proposal_template.md
Normal file
52
proposal/proposal_template.md
Normal file
@ -0,0 +1,52 @@
|
||||
# Proposal Template for 996.icu Projects
|
||||
|
||||
HEAD | SUMMARY
|
||||
-|-|-
|
||||
Title:| Proposal Template for 996.icu Projects
|
||||
Author:| xiao
|
||||
Status:| Draft
|
||||
Type:| Template
|
||||
Created:| 31-Mar-2019
|
||||
Post-History:| None
|
||||
|
||||
## Why this Proposal?
|
||||
|
||||
I write this template for the whole community. <br/>
|
||||
Hope we can record useful and valuable suggestions and make they true.
|
||||
|
||||
## Community Value
|
||||
|
||||
Provide a template for new proposals. <br/>
|
||||
A proposal can be used to record suggestions and aggrements. <br/>
|
||||
It's better for community members to understand and review what import decisions has been made and discussed.
|
||||
|
||||
## Problems
|
||||
|
||||
In this part, the proposer should describle what problems we are facing. <br/>
|
||||
For example, currently, we don't have a way to record import decisions and suggestions. <br/>
|
||||
Pull Requests area is too general and not a good way to express ideas. <br/>
|
||||
We need a much more formal channel.
|
||||
|
||||
## Solutions
|
||||
|
||||
In this part, the proposer should statement the solutions or proposals to solve this problems listed in *Problems* part. <br/>
|
||||
For example, we add the proposal directory in the repo and init this proposal template to help the community to build a much more formal channel for suggestion and discussion.
|
||||
|
||||
## Resource & Requirements
|
||||
|
||||
In this part, list out the resource or other requirements required by the proposal or solution.
|
||||
|
||||
## Actions & implementation Plan
|
||||
|
||||
In this part, the proposer should describle the actions and implementation plan after the proposal is approved by the community.
|
||||
|
||||
## References
|
||||
|
||||
In the part, list out links to the reference resource.
|
||||
For example, for this proposal the main reference is <br/>
|
||||
- [PEP 1 -- PEP Purpose and Guidelines](https://www.python.org/dev/peps/pep-0001/)
|
||||
|
||||
## Copyright
|
||||
|
||||
This document has been placed in the public domain. <br/>
|
||||
*996.ICU Project All Right Reserved 2019*
|
Reference in New Issue
Block a user