Skip to content

Commit 461cee9

Browse files
committed
Put directory structure first
so reader knows what is being described
1 parent 43f544a commit 461cee9

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,6 @@ The Haskell Message Index is generated from a collection of files on
7676
disk using Hakyll. From these files, descriptions of the message are generated,
7777
as well as examples of how to handle them.
7878

79-
Inside the top level of the site source, there is a
80-
`messages` directory. Within `messages`, each subdirectory represents
81-
a message whose name is the message code. This subdirectory contains a
82-
file `index.md` that describes the message. Additionally,
83-
subdirectories of the message directory may represent examples - each
84-
example contains a file `index.md` as well as a number of Haskell,
85-
Cabal, or YAML files that represent the example.
8679

8780
A message with ID `GHC-123` and two examples might have the following structure:
8881

@@ -98,6 +91,14 @@ A message with ID `GHC-123` and two examples might have the following structure:
9891
* `/messages/GHC-123/example2/before/Main.hs` - an example file that exhibits the error
9992
* `/messages/GHC-123/example2/after/Main.hs` - an example file in which the error has been fixed
10093

94+
Inside the top level of the site source, there is a
95+
`messages` directory. Within `messages`, each subdirectory represents
96+
a message whose name is the message code. This subdirectory contains a
97+
file `index.md` that describes the message. Additionally,
98+
subdirectories of the message directory may represent examples - each
99+
example contains a file `index.md` as well as a number of Haskell,
100+
Cabal, or YAML files that represent the example.
101+
101102
The path components `messages` and the two `index.md` files must be
102103
named as specified here, while the other components may vary.
103104

0 commit comments

Comments
 (0)