on master help sign in
Update ‘CONTRIBUTING.md’
a444abcmrkkrp
CONTRIBUTING.md+17−9
@@ -16,14 +16,7 @@ messages and PR descriptions.
16
16
17## What to hack on?
17## What to hack on?
18
18
19−Right now there are two options for people who want to contribute:
20−
21−* [Implementing rendering of AST][cover-ast]. This is the main focus right
19+* [Fixing bugs][bugs]. This is the main focus right now.
22− now because we want to have a MVP which can render all syntactical
23− constructions found in Haskell source code. Once that is achieved we'll
24− polish the tool iteratively.
25−* [Fixing bugs][bugs]. If this seems more interesting than implementing
26− rendering of AST, you are welcome to do this as well.
27
20
28## Implementing rendering of AST
21## Implementing rendering of AST
29
22
@@ -66,5 +59,20 @@ Testing is performed as following:
66Examples can be organized in sub-directories, see the existing ones for
59Examples can be organized in sub-directories, see the existing ones for
67inspiration.
60inspiration.
68
61
69−[cover-ast]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Acovering-ghc-ast
62+## CI
63+
64+We use Circle CI. Some outside contributors may have problems, as in, CI
65+won't run for PRs opened from forks with “unauthorized” errors. In that case
66+the best we can do is to add you as a contributor or to restart your build
67+manually.
68+
69+If you have been added as a contributor but the builds still do not start,
70+try clicking
71+
72+```
73+User settings -> Account integrations -> Refresh permissions
74+```
75+
76+in Circle CI app.
77+
70[bugs]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Abug
78[bugs]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Abug