git.iko.soy/rowtype-yoga/purescript-native
on golang help sign in
Update CONTRIBUTING.md
commitb0b6d392b8df8b8bfd89a27b72a733666934db58 authorPhil Freeman <paf31@cantab.net> dateTue 21 Jul 2015, 17:55 (11 years ago) parentc0dd2e6
1 file changed+9−3
CONTRIBUTING.md+9−3
CONTRIBUTING.md+9−3
@@ -2,14 +2,15 @@ An introductory overview of the compiler is available [here](https://www.youtube
22
33Pull requests are encouraged.
44
5+## Pull Requests
6+
57Please follow the following guidelines:
68
79- Add at least a test to `examples/passing/` and possibly to `examples/failing`.
810- Build the binaries and libs with `cabal build`
911- Install the binaries and libs with `cabal install`.
1012- Run `cabal configure --enable-tests && cabal build && cabal test` to build the test suite.
11−- Run `purescript-test-everything` to make sure you haven't broken any core library builds.
12−- Run `starter-kit` to make sure the starter kit has not been broken.
13+- Build the core libraries by running the script in `core-tests`
1314
1415If you would like to contribute, please consider the issues in the current milestone first. If you are a new contributor, you may want to have a go at the ["easy" issues](https://github.com/purescript/purescript/labels/easy) to get started.
1516
@@ -17,7 +18,7 @@ Finally, if you have made code changes and would like to be included in the copy
1718
1819To prevent core libraries from getting broken, every change must be reviewed. A pull request will be merged as long as one other team member has verified the changes.
1920
20−## Adding dependencies
21+## Adding Dependencies
2122
2223Because the PureScript compiler is distributed in binary form, we include
2324the licenses of all dependencies, including transitive ones, in the LICENSE
@@ -30,3 +31,8 @@ You can automate this (if you have bash):
3031- run at the command line: `./license/generate > LICENSE`
3132
3233[cabal-dependency-licenses]: https://github.com/jaspervdj/cabal-dependency-licenses
34+
35+## Writing Issues
36+
37+- If the issue is actually a question, please consider asking on Reddit, Stack Overflow or IRC first.
38+- Please include a minimal, repeatable test case with any bug report.