on master help sign in
reorder things and add a section on style guides
f7264ebEvan Czaplicki
CONTRIBUTING.md+15−10
@@ -1,7 +1,21 @@
1# Contributing to Elm
1# Contributing to Elm
2
2
3Thanks helping with the development of Elm! This document describes the basic
3Thanks helping with the development of Elm! This document describes the basic
4−standards for opening pull requests:
4+standards for opening pull requests and making the review process as smooth as
5+possible.
6+
7+## Licensing
8+
9+You need to sign the [contributor agreement](ContributorAgreement.pdf)
10+and send it to <info@elm-lang.org> before opening your pull request.
11+
12+## Style Guide
13+
14+ * Haskell &mdash; conform to [these guidelines][haskell]
15+ * JavaScript &mdash; use [Google's JS style guide][js]
16+
17+[haskell]: https://gist.github.com/evancz/0a1f3717c92fe71702be
18+[js]: https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
5
19
6## Branches
20## Branches
7
21
@@ -21,18 +35,9 @@ in as its own branch and do some testing before bringing it into the master
21branch. This way we can keep releases of the master branch independent of new
35branch. This way we can keep releases of the master branch independent of new
22features.
36features.
23
37
24−## Opening a pull request
25−
26−**Please open PRs against the [master branch of Elm][master] whenever possible.**
27−
28Note that the master branch of the compiler should always be in sync with the
38Note that the master branch of the compiler should always be in sync with the
29master branch of the [website][], and the stable branch of the compiler should
39master branch of the [website][], and the stable branch of the compiler should
30always be in sync with the stable branch of the [website][]. Make sure that
40always be in sync with the stable branch of the [website][]. Make sure that
31your changes maintain this compatibility.
41your changes maintain this compatibility.
32
42
33[website]: https://github.com/elm-lang/elm-lang.org
43[website]: https://github.com/elm-lang/elm-lang.org
34−
35−## Licensing
36−
37−You need to sign the [contributor agreement](ContributorAgreement.pdf)
38−and send it to <info@elm-lang.org> before opening your pull request.