Skip to content

Commit a8944c5

Browse files
authored
Reduce project proposal issue template
The proposal bodies will be markdown documents in this repo, so the tracking issues only need to link to them.
1 parent 224f015 commit a8944c5

File tree

1 file changed

+7
-81
lines changed

1 file changed

+7
-81
lines changed

.github/ISSUE_TEMPLATE/project-proposal.md

Lines changed: 7 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -8,87 +8,13 @@ assignees: ''
88
---
99

1010
<!--
11-
This template is intended to be used by those who would like to pitch a new project for one of the Web3 Dev project teams to take on. It should contain sufficient detail that others can understand how this project contributes to our team’s mission of product-market fit 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, and any other information relevant for prioritizing this project against others.
12-
Good project scope aims for ~3-5 engineers for 1-3 months (though feel free to suggest larger-scoped projects anyway). 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.
11+
Project proposals live as Markdown documents in this repo.
12+
After drafting an initial proposal in a PR, file an issue with this template and link to the proposal
13+
detail and PR discussion(s).
1314
-->
1415

15-
### Purpose &amp; impact
16-
##### Background &amp; intent
17-
_Describe the desired state of the world after this project? Why does that matter?_
18-
<!--
19-
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.
20-
-->
21-
22-
##### Assumptions &amp; hypotheses
23-
_What must be true for this project to matter?_
24-
<!--(bullet list)-->
25-
26-
##### User workflow example
27-
_How would a developer or user use this new capability?_
28-
<!--(short paragraph)-->
29-
30-
##### Impact
31-
_How directly important is the outcome to our top-level mission?_
32-
33-
🔥🔥🔥 = 0-3 emoji rating
34-
35-
<!--
36-
Explain why you have chosen this rating
37-
What awesome potential impact/outcomes/results will we see if we nail this project?
38-
-->
39-
40-
##### Leverage
41-
_How much would nailing this project improve our knowledge and ability to execute future projects?_
42-
43-
🎯🎯🎯 = 0-3 emoji rating
44-
45-
<!-- Explain the opportunity or leverage point for our subsequent velocity/impact (e.g. by speeding up development, enabling more contributors, etc)
46-
-->
47-
48-
##### Confidence
49-
_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)_.
50-
51-
<!--Explain why this rating-->
52-
53-
54-
### Project definition
55-
##### Brief plan of attack
56-
57-
<!--Briefly describe the milestones/steps/work needed for this project-->
58-
59-
##### What does done look like?
60-
_What specific deliverables should completed to consider this project done?_
61-
62-
##### What does success look like?
63-
_Success means impact. How will we know we did the right thing?_
64-
65-
<!--
66-
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.
67-
-->
68-
69-
##### Counterpoints &amp; pre-mortem
70-
_Why might this project be lower impact than expected? How could this project fail to complete, or fail to be successful?_
71-
72-
##### Alternatives
73-
_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?_
74-
75-
##### Dependencies/prerequisites
76-
<!--List any other projects that are dependencies/prerequisites for this project that is being pitched.-->
77-
78-
##### Future opportunities
79-
<!--What future projects/opportunities could this project enable?-->
80-
81-
### Required resources
82-
83-
##### Effort estimate
84-
<!--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).
85-
For a team of 3-5 people with the appropriate skills:
86-
- Small, 1-2 weeks
87-
- Medium, 3-5 weeks
88-
- Large, 6-10 weeks
89-
- XLarge, >10 weeks
90-
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.)
91-
-->
16+
Project name: [insert name]
17+
Proposal: [link to markdown file in this repo]
18+
Initial PR: [reference PR number with the first proposal draft]
9219

93-
##### Roles / skills needed
94-
<!--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.-->
20+
This issue is for project management of a proposal, deciding, scheduling etc. Discussion about the relative merits of the proposal is welcome here, but discussion about the content of the proposal is better in a PR to the proposal document.

0 commit comments

Comments
 (0)