Skip to content

Commit 27b59f9

Browse files
Readme update for independent repository
1 parent 7dcad9c commit 27b59f9

File tree

1 file changed

+14
-42
lines changed

1 file changed

+14
-42
lines changed

README.md

Lines changed: 14 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,11 @@
1-
# Haskell Errors
2-
3-
So you would like to help improve the error messages we see in the Haskell toolchain and ecosystem?
4-
5-
Welcome! We're glad to have you, and we will do our best to ensure your efforts are worthwhile.
6-
7-
## Project Goals
8-
9-
* Serve the Haskell community, focusing on improvements to the error messages seen in the Haskell ecosystem.
10-
11-
* Lower Haskell's barrier-to-entry by increasing the general understanding of the error messages experienced during development.
12-
13-
14-
## What and How?
15-
16-
This project is taking shape, so many details are still being worked out, however:
17-
18-
* Using the issue tracker, this repo will provide a space and workflow for the discussion and collaboration around improving error messages.
19-
* We are interested in building a catalog of error messages for each tool in common use (GHC, Cabal, Stack, ghcup, HLS, etc).
20-
* For each error message that is identified for potential improvement:
21-
* We would like to have a reasonable means of reproducing the error message under different circumstances
22-
* We should identify specific improvements to the messaging
23-
* We will reach out to and work collaboratively with tool developers
24-
* We should document and help improve understanding of the error messaging
25-
* For tools that use error message codes:
26-
* We describe the messages and how to interpret them in the Haskell Message Index (see below)
27-
28-
As a result, this repo may include code that demonstrates the errors we wish to improve, as well as code and material to render documentation relevant to explaining each error and the possible situations the error relates to.
29-
30-
31-
## Contributor Expectations
32-
33-
We welcome contributions that help to further progress the project towards its goals.
34-
35-
Contributions may come in the form of changes to the code base, as well as opening or commenting on issues and pull requests.
36-
37-
All contributors are expected to follow the [Haskell Foundation's Code of Conduct](https://haskell.foundation/guidelines-for-respectful-communication/).
38-
39-
## The Haskell Message Index
40-
[![.github/workflows/deploy.yml](https://github.com/haskell/error-messages/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/haskell/error-messages/actions/workflows/deploy.yml)
1+
# The Haskell Message Index
2+
[![.github/workflows/deploy.yml](https://github.com/haskellfoundation/error-message-index/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/haskellfoundation/error-message-index/actions/workflows/deploy.yml)
413

424
Haskell tooling emits a variety of errors, warnings, and other messages. In an unreleased branch, GHC emits a unique code for each message that allows it to be identified. This site allows these codes to be looked up, providing examples, context, and further information that can make them easier to understand.
435

446
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on improving the site. Thanks!
457

46-
### Running Locally
8+
## Running Locally
479

4810
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:
4911
```
@@ -71,6 +33,16 @@ No executables found.
7133
```
7234
typically indicate that the site was started from the root of the repository, rather than the `message-index` directory.
7335

74-
### Maintenance
36+
## Contributor Expectations
37+
38+
We welcome contributions that help to further progress the project towards its goals.
39+
40+
Contributions may come in the form of changes to the code base, as well as opening or commenting on issues and pull requests.
41+
42+
All contributors are expected to follow the [Haskell Foundation's Code of Conduct](https://haskell.foundation/guidelines-for-respectful-communication/).
43+
44+
45+
## Maintenance
7546

7647
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!
48+

0 commit comments

Comments
 (0)