Skip to content

Commit 8922ef8

Browse files
committed
Add tutorial-type section
This section has a lot of FIXMEs at present. I wrote this section for myself! I hope I am representative of the project's target audience.
1 parent 228c957 commit 8922ef8

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@ If you want to contribute to the error message index, make sure that the version
1313

1414
You can manage multiple versions of tools on your system using [GHCup](https://www.haskell.org/ghcup/).
1515

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+
1645
## How to Document a GHC Error Code
1746

1847
To document a new error code, the following workflow can be convenient.

0 commit comments

Comments
 (0)