@@ -1,17 +1,20 @@
1# Contributing to Elm
1# Contributing to Elm
3−Thanks helping with the development of Elm! This document
3+Thanks helping with the development of Elm! This document describes the basic
4−describes the basic standards for opening pull requests:
4+standards for opening pull requests:
8− * [The master branch](https://github.com/elm-lang/Elm/tree/master) is the
9− home of the next release of the compiler so new features and improvements
8+ * [The master branch][master] is the home of the next release of the compiler
9+ so new features and improvements get merged there. Most pull requests
10− get merged there. Most pull requests should target this branch!
10+ should target this branch!
12− * [The stable branch](https://github.com/elm-lang/Elm/tree/stable) is for
13− tagging previous releases and critical bug fixes. This branch is handy for
12+ * [The stable branch][stable] is for tagging releases and critical bug fixes.
14− folks who want to build the most recent public release from source.
13+ This branch is handy for folks who want to build the most recent public
16+[master]: http://github.com/elm-lang/elm/tree/master
17+[stable]: http://github.com/elm-lang/elm/tree/stable
16If you are working on a fairly large feature, we will probably want to merge it
19If you are working on a fairly large feature, we will probably want to merge it
17in as its own branch and do some testing before bringing it into the master
20in as its own branch and do some testing before bringing it into the master
@@ -20,15 +23,14 @@ features.
21## Opening a pull request
24## Opening a pull request
23−**Please open PRs against the [master branch of
26+**Please open PRs against the [master branch of Elm][master] whenever possible.**
24−Elm](http://github.com/elm-lang/elm/tree/master) whenever possible.**
27+
28+Note that the master branch of the compiler should always be in sync with the
29+master branch of the [website][], and the stable branch of the compiler should
30+always be in sync with the stable branch of the [website][]. Make sure that
31+your changes maintain this compatibility.
26−Note that changes in the master branch of [Elm](https://github.com/elm-lang/Elm/)
27−are able to be compiled against the master branch of the [elm-lang.org
28−repo](https://github.com/elm-lang/elm-lang.org), and the stable branch of
29−[Elm](https://github.com/elm-lang/Elm/) is able to be built with the stable
30−branch of the [elm-lang.org repo](https://github.com/elm-lang/elm-lang.org).
33+[website]: https://github.com/elm-lang/elm-lang.org
31−Please make sure that your changes maintain this compatibility.
33## Licensing
35## Licensing