Remove bogus comment on ForAllTy
[ghc.git] / HACKING.md
1 Contributing to the Glasgow Haskell Compiler
2 ============================================
3
4 So you've decided to hack on GHC, congratulations! We hope you have a
5 rewarding experience. This file will point you in the direction of
6 information to help you get started right away.
7
8 The GHC Developer's Wiki
9 ========================
10
11 The home for GHC hackers is our Trac instance, located here:
12
13 <http://ghc.haskell.org/trac/ghc>
14
15 From here, you can file bugs (or look them up,) use the wiki, view the
16 `git` history, among other things. Of particular note is the building
17 page, which has the high level overview of the build process and how
18 to get the source:
19
20 <http://ghc.haskell.org/trac/ghc/wiki/Building>
21
22 Contributing patches to GHC in a hurry
23 ======================================
24
25 Make sure your system has the necessary tools to compile GHC. You can
26 find an overview here:
27
28 <http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation>
29
30 Next, clone the repository and all the associated libraries:
31
32 ```
33 $ git clone --recursive git://git.haskell.org/ghc.git
34 ```
35
36 On Windows, you need an extra repository containing some build tools.
37 These can be downloaded for you by configure. This only needs to be done once by running:
38
39 ```
40 $ ./configure --enable-tarballs-autodownload
41 ```
42
43 First copy `mk/build.mk.sample` to `mk/build.mk` and ensure it has
44 your preferred build settings. (You probably want to at least set
45 `BuildFlavour` to `quick`):
46
47 ```
48 $ cp mk/build.mk.sample mk/build.mk
49 $ ... double-check mk/build.mk ...
50 ```
51
52 Now build. If you have multiple cores, **you should always use them to
53 speed up compilation**:
54
55 ```
56 $ ./boot
57 $ ./configure
58 $ make -jN # <N> is the number of cores you have.
59 ```
60
61 You can use the `./inplace/bin/ghc-stage2` binary to play with the
62 newly built compiler.
63
64 Now, hack on your copy and rebuild (with `make`) as necessary.
65
66 Then start by making your commits however you want. When you're done, you
67 can use `git format-patch` to create a series of `.patch` files you
68 can give to us. In this example, we'll assume I'm on a `bugfix` branch
69 and want to submit my patches:
70
71 ```
72 $ git branch
73 * bugfix
74   master
75 $ git format-patch master -o patches
76 ...
77 $
78 ```
79
80 Now create a trac ticket:
81
82 <http://ghc.haskell.org/trac/ghc/newticket?type=bug>
83
84 And attach the files in your `patches/` directory. Set the status from
85 *new* to *patch* and we'll review it as soon as we can!
86
87 Useful links:
88 =============
89
90 An overview of things like using git, the release process, filing bugs
91 and more can be located here:
92
93 <http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions>
94
95 You can find our coding conventions for the compiler and RTS here:
96
97 <http://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle>
98 <http://ghc.haskell.org/trac/ghc/wiki/Commentary/Rts/Conventions>
99
100 A high level overview of the bug tracker:
101
102 <http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/BugTracker>
103
104 If you're going to contribute regularly, **learning how to use the
105 build system is important** and will save you lots of time. You should
106 read over this page carefully:
107
108 <http://ghc.haskell.org/trac/ghc/wiki/Building/Using>
109
110 How to communicate with us
111 ==========================
112
113 GHC is a big project, so you'll surely need help. Luckily, we can
114 provide plenty through a variety of means!
115
116 ## IRC
117
118 If you're an IRC user, be sure to drop by the official `#ghc` channel
119 on [freenode](http://freenode.org). Many (but not all) of the
120 developers and committers are actively there during a variety of
121 hours.
122
123 ## Mailing lists
124
125 In the event IRC does not work or if you'd like a bigger audience, GHC
126 has several mailing lists for this purpose. The most important one is
127 [ghc-devs](http://www.haskell.org/pipermail/ghc-devs/), which is where
128 the developers actively hang out and discuss incoming changes and
129 problems.
130
131 There is no strict standard about where you post patches - either in
132 `ghc-devs` or in the bug tracker. Ideally, please put it in the bug
133 tracker with test cases or relevant information in a ticket, and set
134 the ticket status to `patch`. By doing this, we'll see the patch
135 quickly and be able to review. This will also ensure it doesn't get
136 lost. But if the change is small and self contained, feel free to
137 attach it to your email, and send it to `ghc-devs`.
138
139 Furthermore, if you're a developer (or want to become one!) you're
140 undoubtedly also interested in the other mailing lists:
141
142  * [glasgow-haskell-users](http://www.haskell.org/mailman/listinfo/glasgow-haskell-users)
143    is where developers/users meet.
144  * [ghc-tickets](http://www.haskell.org/mailman/listinfo/ghc-tickets)
145    for email from Trac.
146  * [ghc-builds](http://www.haskell.org/mailman/listinfo/ghc-builds)
147    for nightly build emails.
148  * [ghc-commits](http://www.haskell.org/mailman/listinfo/ghc-commits)
149    for commit messages when someone pushes to the repository.
150
151 El fin
152 ======
153
154 Happy Hacking!  -- The GHC Team