on master help sign in
Clean up the info a bit
commitcf25fe4105ba054c19a24393fa089c4f2ac2bb09 authorEvan Czaplicki <info@elm-lang.org> dateThu 11 Sep 2014, 17:25 (12 years ago) parent8a21310
1 file changed+18−16
CONTRIBUTING.md+18−16
CONTRIBUTING.md+18−16
@@ -1,17 +1,20 @@
11# Contributing to Elm
22
3−Thanks helping with the development of Elm! This document
4−describes the basic standards for opening pull requests:
3+Thanks helping with the development of Elm! This document describes the basic
4+standards for opening pull requests:
55
66## Branches
77
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
10− get merged there. Most pull requests should target this branch!
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+ should target this branch!
1111
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
14− folks who want to build the most recent public release from source.
12+ * [The stable branch][stable] is for tagging releases and critical bug fixes.
13+ This branch is handy for folks who want to build the most recent public
14+ release from source.
15+
16+[master]: http://github.com/elm-lang/elm/tree/master
17+[stable]: http://github.com/elm-lang/elm/tree/stable
1518
1619If you are working on a fairly large feature, we will probably want to merge it
1720in as its own branch and do some testing before bringing it into the master
@@ -20,15 +23,14 @@ features.
2023
2124## Opening a pull request
2225
23−**Please open PRs against the [master branch of
24−Elm](http://github.com/elm-lang/elm/tree/master) whenever possible.**
26+**Please open PRs against the [master branch of Elm][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.
2532
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).
31−Please make sure that your changes maintain this compatibility.
33+[website]: https://github.com/elm-lang/elm-lang.org
3234
3335## Licensing
3436