Skip to content

Commit b437cd2

Browse files
emilypiemilypi
authored
Merge pull request #3 from haskellfoundation/feat/proposal-template
Add proposal template
2 parents 296151c + 2cee8b3 commit b437cd2

File tree

3 files changed

+111
-0
lines changed

3 files changed

+111
-0
lines changed

‎LICENSE

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2021 Haskell Foundation
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

‎README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,13 @@
1+
<p align="center">
2+
<img src="https://haskellfoundation.github.io/static/images/logos/hf-logo-alpha.png" width="350" height="282" alt="Haskell Foundation" title="Haskell Foundation">
3+
</p>
4+
15
# Haskell Foundation Tech Proposals
6+
7+
[![Hackage](https://img.shields.io/static/v1?label=Haskell%20Foundation&message=official&color=purple&style=for-the-badge)](https://haskell.foundation)
8+
9+
This repository is for the [Haskell Foundation](https://haskell.foundation) tech proposals. Haskell Foundation tech proposals are similar to [GHC proposals](https://github.com/ghc-proposals/ghc-proposals) in that they are the venue by which items are added to the HF technical agenda, pending final review from its Board of Directors. This repository is maintained by the Haskell Foundation and its volunteers. If you would like to get started with a merge request, please consult the documentation below.
10+
11+
## License
12+
13+
This site is open source, and covered under the Apache 2.0 license.

‎TEMPLATE.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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 proposal.
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+
## Motivation
23+
24+
This section should explain the motivation in terms of why Haskell
25+
Foundation should take on this project, and why it is important for the
26+
Haskell ecosystem. What impact will it have? Why should people care?
27+
28+
## Goals
29+
30+
This section should detail the high-level goals of the project, as well
31+
as the criteria for what constitutes a finished project. Deliverables
32+
should support these goals, and the goals should support the motivation
33+
for undertaking the project.
34+
35+
## People
36+
37+
This section should detail the following people:
38+
39+
- **Performers:** the project leads and main developers/resources who will be directly involved in the day to day work. If your project needs performers to be sourced by the Haskell Foundation, please say so here.
40+
41+
- **Reviewers:** people who will be signing off on work done for the proposal at different stages.
42+
43+
- **Stakeholders:** A sample of people who will be directly affected by the project, who can serve as coordinators and advisors.
44+
45+
## Resources
46+
47+
This section should describe the estimated resource cost of the project
48+
as it pertains to the Haskell Foundation. Does the project need funding?
49+
Is there a human cost in terms of hours and effort? We need to know!
50+
51+
## Timeline
52+
53+
This section should detail the high-level time estimate of such a
54+
project, and serve as an educated guess. We acknowledge that no estimate
55+
is accurate, but we should be able to give coarse estimates in terms of
56+
months and years.
57+
58+
## Lifecycle:
59+
60+
This section should detail the development lifecycle of the project, including a
61+
high-level description of the following criteria:
62+
63+
- **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
64+
section should not be as granular as individual merge requests that will be made, but that would be a bonus!
65+
66+
- **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
67+
stakeholders or performers.
68+
69+
- **Performance impact:** An overview of the potential performance impact of this project on the ecosystem, if applicable.
70+
71+
## Deliverables
72+
73+
This section should describe the individual deliverables this project
74+
will bring as a result of the changes described above. These
75+
deliverables should support the end goals of the project and define what
76+
this project is actually delivering to the community.
77+
78+
## Outcomes
79+
80+
This section should describe the expected outcomes of the project, both
81+
positive and negative.
82+
83+
## Risks
84+
85+
This section should detail any potential risks, blockers, or hurdles the
86+
leads expect to encounter throughout the project’s lifecycle.

0 commit comments

Comments
 (0)