Skip to content

Commit f7264eb

Browse files
committed
reorder things and add a section on style guides
1 parent cf25fe4 commit f7264eb

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

CONTRIBUTING.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
# Contributing to Elm
22

33
Thanks 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 <[email protected]> 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
519

620
## Branches
721

@@ -21,18 +35,9 @@ in as its own branch and do some testing before bringing it into the master
2135
branch. This way we can keep releases of the master branch independent of new
2236
features.
2337

24-
## Opening a pull request
25-
26-
**Please open PRs against the [master branch of Elm][master] whenever possible.**
27-
2838
Note that the master branch of the compiler should always be in sync with the
2939
master branch of the [website][], and the stable branch of the compiler should
3040
always be in sync with the stable branch of the [website][]. Make sure that
3141
your changes maintain this compatibility.
3242

3343
[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 <[email protected]> before opening your pull request.

0 commit comments

Comments
 (0)