Skip to content

Commit 977c331

Browse files
committed
Link to reference section
1 parent de8d77d commit 977c331

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,28 @@ out.
2222
The simplest thing to do is create a new file in this repository,
2323
`message-index/messages/GHC-00000/index.md`, and write your documentation there.
2424

25-
Here is a template you can use for the file:
26-
[FIXME: providing a tool would be a lot nicer]
25+
Here is a template you can use for the file [FIXME: use the tool provided by #408 when available.]:
2726

2827
```
2928
---
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? -->
29+
title: <Your title for the message>
30+
summary: <Your short summary, as a sentence.>
31+
severity: <!-- Optional. one of `error` or `warning`. -->
32+
introduced: <!-- Optional. Represents when the **code** for this message was added to the tool -->
33+
flag: <!-- Optional. If it exists, list the tool's flag that enables this message -->
3534
---
3635
37-
YOUR DESCRIPTION GOES HERE
36+
<Your description>
3837
```
3938

4039
You can look at other messages in the Index to get a feel for the documentation style used in
4140
this project.
4241

43-
To explore the full range of documentation possibilities, see [Reference: The Anatomy of a Message] below.
42+
To explore the full range of documentation possibilities, see [The Anatomy of a
43+
Message][anatomy] below. It explains each of the fields in the header above, and includes
44+
another example document for reference.
45+
46+
[anatomy]: #reference-the-anatomy-of-a-message
4447

4548
## If You *Don't* Know Which Message You Want to Document
4649

0 commit comments

Comments
 (0)