Skip to content

Commit 224f015

Browse files
authored
Copy issue template to a markdown file for use in PRs
1 parent a902267 commit 224f015

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

proposals/TEMPLATE.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Project proposal: [outcome or objective here]
2+
3+
<!--
4+
This template is for a proposal/brief/pitch for a significant project to be undertaken by a Web3 Dev project team.
5+
The goal of project proposals is to help us decide which work to take on, which things are more valuable than other things.
6+
A proposal should contain enough detail for others to understand how this project contributes to our team’s mission of product-market fit
7+
for our unified stack of protocols, what is included in scope of the project, where to get started if a project team were to take this on,
8+
and any other information relevant for prioritizing this project against others.
9+
It does not need to describe the work in much detail. Most technical design and planning would take place after a proposal is adopted.
10+
Good project scope aims for ~3-5 engineers for 1-3 months (though feel free to suggest larger-scoped projects anyway).
11+
Projects do not include regular day-to-day maintenance and improvement work, e.g. on testing, tooling, validation, code clarity, refactors for future capability, etc.
12+
-->
13+
14+
### Purpose &amp; impact
15+
##### Background &amp; intent
16+
_Describe the desired state of the world after this project? Why does that matter?_
17+
<!--
18+
Outline the status quo, including any relevant context on the problem you’re seeing that this project should solve. Wherever possible, include pains or problems that you’ve seen users experience to help motivate why solving this problem works towards top-line objectives.
19+
-->
20+
21+
##### Assumptions &amp; hypotheses
22+
_What must be true for this project to matter?_
23+
<!--(bullet list)-->
24+
25+
##### User workflow example
26+
_How would a developer or user use this new capability?_
27+
<!--(short paragraph)-->
28+
29+
##### Impact
30+
_How directly important is the outcome to our top-level mission?_
31+
32+
🔥🔥🔥 = 0-3 emoji rating
33+
34+
<!--
35+
Explain why you have chosen this rating
36+
What awesome potential impact/outcomes/results will we see if we nail this project?
37+
-->
38+
39+
##### Leverage
40+
_How much would nailing this project improve our knowledge and ability to execute future projects?_
41+
42+
🎯🎯🎯 = 0-3 emoji rating
43+
44+
<!-- Explain the opportunity or leverage point for our subsequent velocity/impact (e.g. by speeding up development, enabling more contributors, etc)
45+
-->
46+
47+
##### Confidence
48+
_How sure are we that this impact would be realized? Label from [this scale](https://medium.com/@nimay/inside-product-introduction-to-feature-priority-using-ice-impact-confidence-ease-and-gist-5180434e5b15)_.
49+
50+
<!--Explain why this rating-->
51+
52+
53+
### Project definition
54+
##### Brief plan of attack
55+
56+
<!--Briefly describe the milestones/steps/work needed for this project-->
57+
58+
##### What does done look like?
59+
_What specific deliverables should completed to consider this project done?_
60+
61+
##### What does success look like?
62+
_Success means impact. How will we know we did the right thing?_
63+
64+
<!--
65+
Provide success criteria. These might include particular metrics, desired changes in the types of bug reports being filed, desired changes in qualitative user feedback (measured via surveys, etc), etc.
66+
-->
67+
68+
##### Counterpoints &amp; pre-mortem
69+
_Why might this project be lower impact than expected? How could this project fail to complete, or fail to be successful?_
70+
71+
##### Alternatives
72+
_How might this project’s intent be realized in other ways (other than this project proposal)? What other potential solutions can address the same need?_
73+
74+
##### Dependencies/prerequisites
75+
<!--List any other projects that are dependencies/prerequisites for this project that is being pitched.-->
76+
77+
##### Future opportunities
78+
<!--What future projects/opportunities could this project enable?-->
79+
80+
### Required resources
81+
82+
##### Effort estimate
83+
<!--T-shirt size rating of the size of the project. If the project might require external collaborators/teams, please note in the roles/skills section below).
84+
For a team of 3-5 people with the appropriate skills:
85+
- Small, 1-2 weeks
86+
- Medium, 3-5 weeks
87+
- Large, 6-10 weeks
88+
- XLarge, >10 weeks
89+
Describe any choices and uncertainty in this scope estimate. (E.g. Uncertainty in the scope until design work is complete, low uncertainty in execution thereafter.)
90+
-->
91+
92+
##### Roles / skills needed
93+
<!--Describe the knowledge/skill-sets and team that are needed for this project (e.g. PM, docs, protocol or library expertise, design expertise, etc.). If this project could be externalized to the community or a team outside PL's direct employment, please note that here.-->

0 commit comments

Comments
 (0)