Skip to content

Commit bbc9201

Browse files
committed
Responses to comments from the HFTT.
1 parent 4e3bde2 commit bbc9201

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

proposals/000-error-messages.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,19 +89,21 @@ messages, other central tooling adopts a similar approach. This would, for examp
8989
enable the possibility that HLS can report more informative configuration errors
9090
to users, or even to repair some of the problems itself.
9191

92-
1. Stretch goal: The HF would establish a global namespace for Haskell-tool error
93-
message codes, where each tool includes a code in each message. This would both
94-
broaden the domain of the website index of error messages and also serve to identify
95-
the producer of error messages.
92+
1. Stretch goal: The HF would establish a global namespace for Haskell-tool
93+
error message codes, where each tool is assigned (say) a prefix it should use
94+
for any error codes. The HF would then encourage tools to use these prefixes
95+
in error codes when presenting messages.
9696

9797
## What the Haskell Foundation Would Do
9898

9999
This section is meant to be suggestive of the concrete activity that would support
100100
this proposal. It is possible the HFTT or other HF people would have an alternative
101101
approach, which is fine, too.
102102

103-
1. Devote the time of an HF employee (hereby called the Coordinator) to stay on top of
104-
this project. I think it would be reasonable to timebox this work at 5 hours / week from
103+
1. Devote the time of an HF person, hereby called the Coordinator, to stay on top of
104+
this project. The Coordinator could be an HF employee, an in-kind donation of labor,
105+
or perhaps a dedicated and trustworthy volunteer.
106+
I think it would be reasonable to timebox this work at 5 hours / week from
105107
the Coordinator.
106108

107109
1. A key task of the Coordinator is to source volunteers to help with this initiative.
@@ -117,6 +119,7 @@ error messages in GHC, by working with current contributors (e.g. Alfredo di Nap
117119
Derbyshire, Richard Eisenberg) and looking at the GHC source code. The Coordinator
118120
would then identify an area within GHC that would be an appropriate next step to add
119121
similar structured error messages and source volunteers to contribute to that area.
122+
The Coordinator would help to shepherd any GHC MRs that would arise as part of this work.
120123

121124
1. In parallel with the previous item, the Coordinator would work with representatives
122125
from the HLS team to figure out how HLS might take advantage of the structured error messages
@@ -204,6 +207,20 @@ old hands) understand error messages better.
204207

205208
## Risks
206209

210+
- It is currently unclear who would best serve as the Coordinator, which is why this
211+
proposal leaves this role abstract. Accordingly, a risk is that there is no one suitable.
212+
However, I still believe this proposal is worth considering (and perhaps approving) in this
213+
state: it would then serve as a concrete task the HF could have when an appropriate
214+
Coordinator arises. In the meantime, it could be used as an idea to show potential sponsors
215+
who might want to know what initiatives the HF is considering or to use as part of a motivation
216+
for expanding the HF employment base.
217+
218+
- Much of the work in this proposal is designed to be done by volunteers, working in parallel.
219+
It is possible we will not find the right volunteers for this work. It is then possible
220+
for the Coordinator to do more work themselves. In any case, trying to source volunteers for
221+
this work could be an important learning experience in the lifetime of the HF, and it informs
222+
the design of future initiatives.
223+
207224
- One risk is that the API being built around error messages is not useful to consumers.
208225
This risk is intended to be mitigated by an early consultation with HLS.
209226

0 commit comments

Comments
 (0)