Skip to content

Commit 2cee8b3

Browse files
committed
Add expanded, branded README
Add TEMPLATE.md
1 parent 1e1b233 commit 2cee8b3

File tree

3 files changed

+34
-10
lines changed

3 files changed

+34
-10
lines changed

LICENSE

+13
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

+12
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

+9-10
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33

44

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.
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.
66

77

88

99
## Introduction
1010

1111
This section should detail the following: A summary of the proposal’s
1212
motivation, implementation, risks, timeline, and goals. It should aim to
13-
be an abstract for the proposals.
13+
be an abstract for the proposal.
1414

1515
## Background
1616

@@ -19,7 +19,6 @@ needed to understand the proposal’s motivation (e.g. a high level
1919
overview of the technical details and some history).
2020

2121

22-
2322
## Motivation
2423

2524
This section should explain the motivation in terms of why Haskell
@@ -37,10 +36,10 @@ for undertaking the project.
3736

3837
This section should detail the following people:
3938

40-
- **Performers:** the project leads and main developers/resources who will be directly involved in the day to day work.
41-
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+
4241
- **Reviewers:** people who will be signing off on work done for the proposal at different stages.
43-
42+
4443
- **Stakeholders:** A sample of people who will be directly affected by the project, who can serve as coordinators and advisors.
4544

4645
## Resources
@@ -58,23 +57,23 @@ months and years.
5857

5958
## Lifecycle:
6059

61-
This section should detail the SDLC of the project, including a
60+
This section should detail the development lifecycle of the project, including a
6261
high-level description of the following criteria:
6362

6463
- **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
6564
section should not be as granular as individual merge requests that will be made, but that would be a bonus!
66-
65+
6766
- **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
6867
stakeholders or performers.
69-
68+
7069
- **Performance impact:** An overview of the potential performance impact of this project on the ecosystem, if applicable.
7170

7271
## Deliverables
7372

7473
This section should describe the individual deliverables this project
7574
will bring as a result of the changes described above. These
7675
deliverables should support the end goals of the project and define what
77-
HF is actually delivering to the community.
76+
this project is actually delivering to the community.
7877

7978
## Outcomes
8079

0 commit comments

Comments
 (0)