Skip to content

Commit f48257b

Browse files
authored
Template tweaks after first use
Added authors and PR reference. Adjusted heading levels for use in document rather than issue.
1 parent a8944c5 commit f48257b

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

proposals/TEMPLATE.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,42 @@
1-
# Project proposal: [outcome or objective here]
1+
# [outcome or objective here]
2+
3+
Authors: <!-- List authors' GitHub or other handles -->
4+
5+
Initial PR: TBD <!-- Reference the PR first proposing this document. Oooh, self-reference! -->
26

37
<!--
48
This template is for a proposal/brief/pitch for a significant project to be undertaken by a Web3 Dev project team.
59
The goal of project proposals is to help us decide which work to take on, which things are more valuable than other things.
10+
-->
11+
<!--
612
A proposal should contain enough detail for others to understand how this project contributes to our team’s mission of product-market fit
713
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,
814
and any other information relevant for prioritizing this project against others.
915
It does not need to describe the work in much detail. Most technical design and planning would take place after a proposal is adopted.
1016
Good project scope aims for ~3-5 engineers for 1-3 months (though feel free to suggest larger-scoped projects anyway).
1117
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.
1218
-->
19+
<!--
20+
For ease of discussion in PRs, consider breaking lines after every sentence or long phrase.
21+
-->
1322

14-
### Purpose &amp; impact
15-
##### Background &amp; intent
23+
## Purpose &amp; impact
24+
#### Background &amp; intent
1625
_Describe the desired state of the world after this project? Why does that matter?_
1726
<!--
1827
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.
1928
-->
2029

21-
##### Assumptions &amp; hypotheses
30+
#### Assumptions &amp; hypotheses
2231
_What must be true for this project to matter?_
2332
<!--(bullet list)-->
2433

25-
##### User workflow example
34+
#### User workflow example
2635
_How would a developer or user use this new capability?_
2736
<!--(short paragraph)-->
2837

29-
##### Impact
30-
_How directly important is the outcome to our top-level mission?_
38+
#### Impact
39+
_How directly important is the outcome to web3 dev stack product-market fit?_
3140

3241
🔥🔥🔥 = 0-3 emoji rating
3342

@@ -36,50 +45,50 @@ Explain why you have chosen this rating
3645
What awesome potential impact/outcomes/results will we see if we nail this project?
3746
-->
3847

39-
##### Leverage
48+
#### Leverage
4049
_How much would nailing this project improve our knowledge and ability to execute future projects?_
4150

4251
🎯🎯🎯 = 0-3 emoji rating
4352

4453
<!-- Explain the opportunity or leverage point for our subsequent velocity/impact (e.g. by speeding up development, enabling more contributors, etc)
4554
-->
4655

47-
##### Confidence
56+
#### Confidence
4857
_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)_.
4958

5059
<!--Explain why this rating-->
5160

5261

53-
### Project definition
54-
##### Brief plan of attack
62+
## Project definition
63+
#### Brief plan of attack
5564

5665
<!--Briefly describe the milestones/steps/work needed for this project-->
5766

58-
##### What does done look like?
67+
#### What does done look like?
5968
_What specific deliverables should completed to consider this project done?_
6069

61-
##### What does success look like?
70+
#### What does success look like?
6271
_Success means impact. How will we know we did the right thing?_
6372

6473
<!--
6574
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.
6675
-->
6776

68-
##### Counterpoints &amp; pre-mortem
77+
#### Counterpoints &amp; pre-mortem
6978
_Why might this project be lower impact than expected? How could this project fail to complete, or fail to be successful?_
7079

71-
##### Alternatives
80+
#### Alternatives
7281
_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?_
7382

74-
##### Dependencies/prerequisites
83+
#### Dependencies/prerequisites
7584
<!--List any other projects that are dependencies/prerequisites for this project that is being pitched.-->
7685

77-
##### Future opportunities
86+
#### Future opportunities
7887
<!--What future projects/opportunities could this project enable?-->
7988

80-
### Required resources
89+
## Required resources
8190

82-
##### Effort estimate
91+
#### Effort estimate
8392
<!--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).
8493
For a team of 3-5 people with the appropriate skills:
8594
- Small, 1-2 weeks
@@ -89,5 +98,5 @@ For a team of 3-5 people with the appropriate skills:
8998
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.)
9099
-->
91100

92-
##### Roles / skills needed
101+
#### Roles / skills needed
93102
<!--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)