Skip to content

Commit 1e1b233

Browse files
committed
Add tech proposal template
1 parent 296151c commit 1e1b233

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

TEMPLATE.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Tech Proposal Template
2+
3+
4+
5+
This template is for Haskell Foundation technical agenda proposals. You may find existing proposals and more examples at the [tech-proposals](https://github.com/haskellfoundation/tech-proposals) repository.
6+
7+
8+
9+
## Introduction
10+
11+
This section should detail the following: A summary of the proposal’s
12+
motivation, implementation, risks, timeline, and goals. It should aim to
13+
be an abstract for the proposals.
14+
15+
## Background
16+
17+
This section should explain any background (targeting a casual audience)
18+
needed to understand the proposal’s motivation (e.g. a high level
19+
overview of the technical details and some history).
20+
21+
22+
23+
## Motivation
24+
25+
This section should explain the motivation in terms of why Haskell
26+
Foundation should take on this project, and why it is important for the
27+
Haskell ecosystem. What impact will it have? Why should people care?
28+
29+
## Goals
30+
31+
This section should detail the high-level goals of the project, as well
32+
as the criteria for what constitutes a finished project. Deliverables
33+
should support these goals, and the goals should support the motivation
34+
for undertaking the project.
35+
36+
## People
37+
38+
This section should detail the following people:
39+
40+
- **Performers:** the project leads and main developers/resources who will be directly involved in the day to day work.
41+
42+
- **Reviewers:** people who will be signing off on work done for the proposal at different stages.
43+
44+
- **Stakeholders:** A sample of people who will be directly affected by the project, who can serve as coordinators and advisors.
45+
46+
## Resources
47+
48+
This section should describe the estimated resource cost of the project
49+
as it pertains to the Haskell Foundation. Does the project need funding?
50+
Is there a human cost in terms of hours and effort? We need to know!
51+
52+
## Timeline
53+
54+
This section should detail the high-level time estimate of such a
55+
project, and serve as an educated guess. We acknowledge that no estimate
56+
is accurate, but we should be able to give coarse estimates in terms of
57+
months and years.
58+
59+
## Lifecycle:
60+
61+
This section should detail the SDLC of the project, including a
62+
high-level description of the following criteria:
63+
64+
- **Implementation:** A high-level overview of the implementation details of the project, including how the leaders expect to make progress on individual goals and key progress indicators. This
65+
section should not be as granular as individual merge requests that will be made, but that would be a bonus!
66+
67+
- **Compatibility issues:** highlight any potential compatibility issues that may arise from the changes brought by this project, including any work that needs to be done on the part of
68+
stakeholders or performers.
69+
70+
- **Performance impact:** An overview of the potential performance impact of this project on the ecosystem, if applicable.
71+
72+
## Deliverables
73+
74+
This section should describe the individual deliverables this project
75+
will bring as a result of the changes described above. These
76+
deliverables should support the end goals of the project and define what
77+
HF is actually delivering to the community.
78+
79+
## Outcomes
80+
81+
This section should describe the expected outcomes of the project, both
82+
positive and negative.
83+
84+
## Risks
85+
86+
This section should detail any potential risks, blockers, or hurdles the
87+
leads expect to encounter throughout the project’s lifecycle.

0 commit comments

Comments
 (0)