@@ -13,6 +13,35 @@ If you want to contribute to the error message index, make sure that the version
13
13
14
14
You can manage multiple versions of tools on your system using [ GHCup] ( https://www.haskell.org/ghcup/ ) .
15
15
16
+ ## If You Know Which Message You Want to Document
17
+
18
+ Let's say you ran across ` GHC-00000 ` in the wild, but it wasn't yet documented
19
+ in the Haskell Message Index. You know a little about it and would like to help
20
+ out.
21
+
22
+ The simplest thing to do is create a new file in this repository,
23
+ ` message-index/messages/GHC-00000/index.md ` , and write your documentation there.
24
+
25
+ Here is a template you can use for the file:
26
+ [ FIXME: providing a tool would be a lot nicer]
27
+
28
+ ```
29
+ ---
30
+ title: [FIXME: Is this something written by the contributor, or does it come from the tool?]
31
+ summary: [FIXME: Is this something written by the contributor, or does it come from the tool?]
32
+ severity: [FIXME]: What are the possible values here?
33
+ introduced: <!-- Optional, but good to add if you know when the message was added to the tool -->
34
+ flag: <!-- Optional. Is there a flag that enables this message? -->
35
+ ---
36
+
37
+ YOUR DESCRIPTION GOES HERE
38
+ ```
39
+
40
+ You can look at other messages in the Index to get a feel for the documentation style used in
41
+ this project.
42
+
43
+ To explore the full range of documentation possibilities, see [ Reference: The Anatomy of a Message] below.
44
+
16
45
## How to Document a GHC Error Code
17
46
18
47
To document a new error code, the following workflow can be convenient.
0 commit comments