Skip to content

Commit 5b4190a

Browse files
committed
Add direct reference to create-message-template.hs
1 parent c9e8596 commit 5b4190a

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,30 @@ You can manage multiple versions of tools on your system using [GHCup](https://w
1717

1818
Let's say you ran across `GHC-00000` in the wild, but it wasn't yet documented
1919
in the Haskell Message Index. You know a little about it and would like to help
20-
out.
20+
out. Here's how you can document it, using a command-line tool found in this
21+
repository.
2122

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.
23+
*(If you aren't familiar with git, you can simply [create a new
24+
issue][new-issue] and someone will help you out.)*
2425

25-
Here is a template you can use for the file [FIXME: use the tool provided by #408 when available.]:
26+
[new-issue]: https://github.com/haskellfoundation/error-message-index/issues/new
2627

27-
```
28-
---
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 -->
34-
---
28+
1. Change to the `message-index` directory.
29+
2. Execute `runghc create-message-template.hs` and answer the questions.
30+
3. Optionally commit the new files and create a draft pull request right away.
3531

36-
<Your description>
37-
```
32+
The files created by the tool will need further editing, but it's never too
33+
early to get feedback by opening an issue or pull request.
3834

39-
You can look at other messages in the Index to get a feel for the documentation style used in
40-
this project.
35+
Here is a collection of other tips:
4136

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.
37+
- To explore the full range of documentation possibilities, see [The Anatomy of
38+
a Message][anatomy] below. It explains each of the fields in the header above,
39+
and includes another example document for reference.
40+
- Remember to search the tool's source code for the error number to learn more about
41+
it! Your error may already have code documentation or examples in the test suite.
42+
- You can also look at other messages in the Index to get a feel for the
43+
documentation style used in this project.
4544

4645
[anatomy]: #reference-the-anatomy-of-a-message
4746

0 commit comments

Comments
 (0)