You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,16 +42,31 @@ this project.
42
42
43
43
To explore the full range of documentation possibilities, see [Reference: The Anatomy of a Message] below.
44
44
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?
46
48
47
49
We keep track of which GHC errors are being worked on, and which still require documentation,
48
50
using a bunch of issues:
49
51
50
52
-[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.
51
53
- 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
+
52
61
- 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
53
62
- 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
54
63
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
+
55
70
## Reference: The Anatomy of a Message
56
71
57
72
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
134
149
example. The `index.md` file should explain how the files illustrate
135
150
the message.
136
151
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
-
144
152
## Reference: How to Document a GHC Error Code
145
153
146
154
[FIXME I don't know how, or why, to follow these steps. Can someone who's submitted a
0 commit comments