Skip to content

Commit cbe0950

Browse files
Clarify template instructions
1 parent 24c7600 commit cbe0950

File tree

3 files changed

+51
-47
lines changed

3 files changed

+51
-47
lines changed
Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,51 @@
11
# Community Project Template - place your title here
22

3-
This template is for Haskell Foundation Technical Proposals that are community projects asking for support.
4-
Community project proposals are requests that the Haskell Foundation allocate funding to a particular project or goal to be executed by community members.
3+
_This template is for Haskell Foundation Technical Proposals that are community projects asking for support.
4+
Community project proposals are requests that the Haskell Foundation allocate funding to a particular project or goal to be executed by community members._
5+
6+
_Please delete the italic text before submitting._
7+
58

69
## Abstract
710

8-
This section should provide a summary of the proposal that identifies the key problems to be solved and summarizes the solution.
11+
_This section should provide a summary of the proposal that identifies the key problems to be solved and summarizes the solution._
912

1013
## Background
1114

12-
This section should explain any background (targeting a casual audience) needed to understand the proposal’s motivation (e.g. a high level overview of the technical details and some history).
15+
_This section should explain any background (targeting a casual audience) needed to understand the proposal’s motivation (e.g. a high level overview of the technical details and some history)._
1316

1417
## Problem Statement
1518

16-
This section should describe the problem that the proposal intends to solve and how solving the problem will benefit the Haskell community.
17-
It should also enumerate the requirements against which a solution should be evaluated.
19+
_This section should describe the problem that the proposal intends to solve and how solving the problem will benefit the Haskell community.
20+
It should also enumerate the requirements against which a solution should be evaluated._
1821

1922
## Prior Art and Related Efforts
2023

21-
This section should describe prior attempts to solve the problem, other relevant prior work, and what others in the community are doing to address the problem.
24+
_This section should describe prior attempts to solve the problem, other relevant prior work, and what others in the community are doing to address the problem.
2225
It should describe the relationship between the proposed work and the existing efforts.
23-
If past attempts did not succeed, this section should provide a theory of why not.
26+
If past attempts did not succeed, this section should provide a theory of why not._
2427

2528
## Technical Content
2629

27-
This section should describe the work that is being proposed to the community for comment, including both technical aspects (choices of system architecture, integration with existing tools and workflows) and community governance (how the developed project will be administered, maintained, and otherwise cared for in the future).
30+
_This section should describe the work that is being proposed to the community for comment, including both technical aspects (choices of system architecture, integration with existing tools and workflows) and community governance (how the developed project will be administered, maintained, and otherwise cared for in the future).
2831
It should also describe the benefits, drawbacks, and risks that are associated with these decisions.
29-
It can be a good idea to describe alternative approaches here as well, and why the proposer prefers the current approach.
32+
It can be a good idea to describe alternative approaches here as well, and why the proposer prefers the current approach._
3033

3134
## Timeline
3235

33-
When will the project be completed?
34-
What are the intermediate steps and intermediate concrete deliverables for the community?
36+
_When will the project be completed?
37+
What are the intermediate steps and intermediate concrete deliverables for the community?_
3538

3639
## Budget
3740

38-
How much money is needed to accomplish the goal? How will it be used?
41+
_How much money is needed to accomplish the goal?
42+
How will it be used?_
3943

4044
## Stakeholders
4145

42-
Who stands to gain or lose from the implementation of this proposal?
43-
Proposals should identify stakeholders so that they can be contacted for input, and a final decision should not occur without having made a good-faith effort to solicit representative feedback from important stakeholder groups.
46+
_Who stands to gain or lose from the implementation of this proposal?
47+
Proposals should identify stakeholders so that they can be contacted for input, and a final decision should not occur without having made a good-faith effort to solicit representative feedback from important stakeholder groups._
4448

4549
## Success
4650

47-
Under what conditions will the project be considered a success?
51+
_Under what conditions will the project be considered a success?_

proposals/templates/HFProject.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
# Haskell Foundation Project Template - place your title here
22

3-
This template is for Haskell Foundation Technical Proposals that are projects to be executed by the Haskell Foundation, without necessarily
4-
having any further involvement by the proposer.
3+
_This template is for Haskell Foundation Technical Proposals that are projects to be executed by the Haskell Foundation, without necessarily having any further involvement by the proposer._
54

5+
_Please delete the italic text before submitting._
66

77
## Abstract
88

9-
This section should provide a summary of the proposal that identifies the key problems to be solved and summarizes the solution.
9+
_This section should provide a summary of the proposal that identifies the key problems to be solved and summarizes the solution._
1010

1111
## Background
1212

13-
This section should explain any background (targeting a casual audience) needed to understand the proposal’s motivation (e.g. a high level overview of the technical details and some history).
13+
_This section should explain any background (targeting a casual audience) needed to understand the proposal’s motivation (e.g. a high level overview of the technical details and some history)._
1414

1515
## Problem Statement
1616

17-
This section should describe the problem that the proposal intends to solve and how solving the problem will benefit the Haskell community.
18-
It should also enumerate the requirements against which a solution should be evaluated.
17+
_This section should describe the problem that the proposal intends to solve and how solving the problem will benefit the Haskell community.
18+
It should also enumerate the requirements against which a solution should be evaluated._
1919

2020
## Prior Art and Related Efforts
2121

22-
This section should describe prior attempts to solve the problem, other relevant prior work, and what others in the community are doing to address the problem.
22+
_This section should describe prior attempts to solve the problem, other relevant prior work, and what others in the community are doing to address the problem.
2323
It should describe the relationship between the proposed work and the existing efforts.
24-
If past attempts did not succeed, this section should provide a theory of why not.
24+
If past attempts did not succeed, this section should provide a theory of why not._
2525

2626
## Technical Content
2727

28-
This section should describe the work that is being proposed to the community for comment, including both technical aspects (choices of system architecture, integration with existing tools and workflows) and community governance (how the developed project will be administered, maintained, and otherwise cared for in the future).
28+
_This section should describe the work that is being proposed to the community for comment, including both technical aspects (choices of system architecture, integration with existing tools and workflows) and community governance (how the developed project will be administered, maintained, and otherwise cared for in the future).
2929
It should also describe the benefits, drawbacks, and risks that are associated with these decisions.
30-
It can be a good idea to describe alternative approaches here as well, and why the proposer prefers the current approach.
30+
It can be a good idea to describe alternative approaches here as well, and why the proposer prefers the current approach._
3131

3232
## Timeline
3333

34-
Are there any deadlines that the HF needs to be aware of?
34+
_Are there any deadlines that the HF needs to be aware of?_
3535

3636
## Budget
3737

38-
How much money is needed to accomplish the goal?
39-
How will it be used?
38+
_How much money is needed to accomplish the goal?
39+
How will it be used?_
4040

4141
## Stakeholders
4242

43-
Who stands to gain or lose from the implementation of this proposal?
44-
Proposals should identify stakeholders so that they can be contacted for input, and a final decision should not occur without having made a good-faith effort to solicit representative feedback from important stakeholder groups.
43+
_Who stands to gain or lose from the implementation of this proposal?
44+
Proposals should identify stakeholders so that they can be contacted for input, and a final decision should not occur without having made a good-faith effort to solicit representative feedback from important stakeholder groups._
4545

4646
## Success
4747

48-
Under what conditions will the project be considered a success?
48+
_Under what conditions will the project be considered a success?_
4949

proposals/templates/RFC.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
# RFC Template - place your title here
22

3-
This template is for Haskell Foundation Technical Proposals that have the character of a request for comment (RFC).
3+
_This template is for Haskell Foundation Technical Proposals that have the character of a request for comment (RFC).
44
An RFC is a project with importance to the broad Haskell community that the proposer intends to execute themselves, using their own resources.
5-
The proposer is seeking feedback from the community to help make the project a success.
5+
The proposer is seeking feedback from the community to help make the project a success._
6+
7+
_Please delete the italic text before submitting._
68

79
## Abstract
810

9-
This section should provide a summary of the proposal that identifies the key problems to be solved and summarizes the solution.
11+
_This section should provide a summary of the proposal that identifies the key problems to be solved and summarizes the solution._
1012

1113
## Background
1214

13-
This section should explain any background (targeting a casual audience) needed to understand the proposal’s motivation (e.g. a high level
14-
overview of the technical details and some history).
15+
_This section should explain any background (targeting a casual audience) needed to understand the proposal’s motivation (e.g. a high level overview of the technical details and some history)._
1516

1617
## Problem Statement
1718

18-
This section should describe the problem that the proposal intends to solve and how solving the problem will benefit the Haskell community.
19-
It should also enumerate the requirements against which a solution should be evaluated.
19+
_This section should describe the problem that the proposal intends to solve and how solving the problem will benefit the Haskell community.
20+
It should also enumerate the requirements against which a solution should be evaluated._
2021

2122
## Prior Art and Related Efforts
2223

23-
This section should describe prior attempts to solve the problem, other relevant prior work, and what others in the community are doing
24-
to address the problem. It should describe the relationship between the proposed work and the existing efforts.
25-
If past attempts did not succeed, this section should provide a theory of why not.
24+
_This section should describe prior attempts to solve the problem, other relevant prior work, and what others in the community are doing to address the problem. It should describe the relationship between the proposed work and the existing efforts.
25+
If past attempts did not succeed, this section should provide a theory of why not._
2626

2727
## Technical Content
2828

29-
This section should describe the work that is being proposed to the community for comment, including both technical aspects (choices of system architecture, integration with existing tools and workflows) and community governance (how the developed project will be administered, maintained, and otherwise cared for in the future).
30-
It should also describe the benefits, drawbacks, and risks that are associated with these decisions.
29+
_This section should describe the work that is being proposed to the community for comment, including both technical aspects (choices of system architecture, integration with existing tools and workflows) and community governance (how the developed project will be administered, maintained, and otherwise cared for in the future).
30+
It should also describe the benefits, drawbacks, and risks that are associated with these decisions._
3131

3232
## Stakeholders
3333

34-
Who stands to gain or lose from the implementation of this proposal?
35-
Proposals should identify stakeholders so that they can be contacted for input, and a final decision should not occur without having made a good-faith effort to solicit representative feedback from important stakeholder groups.
34+
_Who stands to gain or lose from the implementation of this proposal?
35+
Proposals should identify stakeholders so that they can be contacted for input, and a final decision should not occur without having made a good-faith effort to solicit representative feedback from important stakeholder groups._
3636

3737
## Success
3838

39-
When will the project be considered a success? How long is it expected to take?
39+
_When will the project be considered a success? How long is it expected to take?_

0 commit comments

Comments
 (0)