Skip to content

Commit 413c6ba

Browse files
committed
Streamline description of other ways of helping
1 parent f757e80 commit 413c6ba

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,31 @@ this project.
4242

4343
To explore the full range of documentation possibilities, see [Reference: The Anatomy of a Message] below.
4444

45-
### Task Lists
45+
## If You *Don't* Know Which Message You Want to Document
46+
47+
Interested in helping out, but not sure where to start?
4648

4749
We keep track of which GHC errors are being worked on, and which still require documentation,
4850
using a bunch of issues:
4951

5052
- [All error codes that still need documenting are collected here](https://github.com/haskellfoundation/error-message-index/issues/162). This issue contains links to individual issues for every error, allowing the list to be updated as PRs are merged. These individual issues for every error may also contain helpful links to test cases, suggestions on examples, and useful metadata to a contributor.
5153
- There is also an (incomplete) list of issues tagged `good first issue`; these are errors which are especially good for newer contributors to document (no incredibly esoteric type-level errors that are hard to understand, let alone describe!): https://github.com/haskellfoundation/error-message-index/labels/good%20first%20issue
54+
55+
Once you've identified an issue you'd like to work on, refer to the previous section for how to get started.
56+
57+
### Helping With the Site Itself
58+
59+
There's more to the Message Index than messages!
60+
5261
- Issues related to improving the site, the workflow for contributing, or other information are tagged `error-message-index-site`: https://github.com/haskellfoundation/error-message-index/labels/error-message-index-site
5362
- Issues related to improving, clarifying, or extending existing documentation are tagged `error-message-index-improvements`: https://github.com/haskellfoundation/error-message-index/labels/error-message-index-improvements
5463

64+
65+
The site is generated using [Hakyll](https://jaspervdj.be/hakyll/).
66+
Pull requests that make it easier to understand or navigate are very
67+
welcome. The main generator `site.hs` is formatted using
68+
[Ormolu](https://github.com/tweag/ormolu).
69+
5570
## Reference: The Anatomy of a Message
5671

5772
The Haskell Message Index is generated from a collection of files on
@@ -134,13 +149,6 @@ field. All `.hs` files are shown in the list of files for the
134149
example. The `index.md` file should explain how the files illustrate
135150
the message.
136151

137-
## Contributing to the Site
138-
139-
The site is generated using [Hakyll](https://jaspervdj.be/hakyll/).
140-
Pull requests that make it easier to understand or navigate are very
141-
welcome. The main generator `site.hs` is formatted using
142-
[Ormolu](https://github.com/tweag/ormolu).
143-
144152
## Reference: How to Document a GHC Error Code
145153

146154
[FIXME I don't know how, or why, to follow these steps. Can someone who's submitted a

0 commit comments

Comments
 (0)