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
+38-5Lines changed: 38 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,23 +52,56 @@ We keep track of which GHC errors are being worked on and which still require do
52
52
53
53
-[All error codes that still need documenting are collected here](https://github.com/haskellfoundation/error-message-index/issues/307). 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.
54
54
- 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
55
+
- 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
55
56
56
57
Once you've identified an issue you'd like to work on, refer to the previous section for how to get started.
57
58
58
-
###Helping With the Site Itself
59
+
## Helping With the Site Itself
59
60
60
61
There's more to the Message Index than messages!
61
62
62
-
- 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
63
-
- 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
63
+
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
64
64
65
65
66
66
The site is generated using [Hakyll](https://jaspervdj.be/hakyll/).
67
67
Pull requests that make it easier to understand or navigate are very
68
68
welcome. The main generator `site.hs` is formatted using
69
-
[Ormolu](https://github.com/tweag/ormolu).
69
+
[Ormolu](https://github.com/tweag/ormolu). See [Technology
70
+
choices][tech-choices] below for more info.
71
+
72
+
[tech-choices]: #reference-technology-choices
73
+
74
+
### Running Locally
75
+
76
+
The site is built with the [Hakyll](https://jaspervdj.be/hakyll/) static site generator. To view the site locally, enter the `message-index` directory and run:
77
+
```console
78
+
$ cabal run -- site watch
79
+
```
80
+
or
81
+
```console
82
+
$ stack run -- site watch
83
+
```
84
+
which fires up an HTTP server on `localhost:8000`.
85
+
86
+
The error messages:
87
+
```
88
+
cabal: There is no <pkgname>.cabal package file or cabal.project file. To
89
+
build packages locally you need at minimum a <pkgname>.cabal file. You can use
90
+
'cabal init' to create one.
91
+
92
+
For non-trivial projects you will also want a cabal.project file in the root
93
+
directory of your project. This file lists the packages in your project and
94
+
all other build configuration. See the Cabal user guide for full details.
95
+
```
96
+
and
97
+
```
98
+
No executables found.
99
+
```
100
+
typically indicate that the site was started from the root of the repository, rather than the `message-index` directory.
101
+
102
+
### `create-message-template`
70
103
71
-
Finally, if you want to work on the scaffolding tool, it has a simplistic test script at
104
+
If you want to work on the scaffolding tool itself, note that it has a test script at
Copy file name to clipboardExpand all lines: README.md
-28Lines changed: 0 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,34 +23,6 @@ Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on improving th
23
23
24
24
If you're a Haskell tool developer who would like to integrate your project with the site, please refer to [tool-developers.md](./tool-developers.md) for recommendations regarding the error codes themselves.
25
25
26
-
## Running Locally
27
-
28
-
The site is built with the [Hakyll](https://jaspervdj.be/hakyll/) static site generator. To view the site locally, enter the `message-index` directory and run:
29
-
```console
30
-
$ cabal run -- site watch
31
-
```
32
-
or
33
-
```console
34
-
$ stack run -- site watch
35
-
```
36
-
which fires up an HTTP server on `localhost:8000`.
37
-
38
-
The error messages:
39
-
```
40
-
cabal: There is no <pkgname>.cabal package file or cabal.project file. To
41
-
build packages locally you need at minimum a <pkgname>.cabal file. You can use
42
-
'cabal init' to create one.
43
-
44
-
For non-trivial projects you will also want a cabal.project file in the root
45
-
directory of your project. This file lists the packages in your project and
46
-
all other build configuration. See the Cabal user guide for full details.
47
-
```
48
-
and
49
-
```
50
-
No executables found.
51
-
```
52
-
typically indicate that the site was started from the root of the repository, rather than the `message-index` directory.
53
-
54
26
## Maintenance
55
27
56
28
The Message Index is a project of the [Haskell Foundation](http://haskell.foundation). Please get in touch if you have ideas, requests, or any other feedback!
0 commit comments