on master help sign in
Update to match new branch structure, fixes #574
67f6d1aEvan Czaplicki
CONTRIBUTING.md+20−19
@@ -5,31 +5,32 @@ describes the basic standards for opening pull requests:
5
5
6## Branches
6## Branches
7
7
8− * The master branch of Elm is for tagging previous releases
8+ * [The master branch](https://github.com/elm-lang/Elm/tree/master) is the
9− and non-breaking changes, like bug fixes. This branch is
9+ home of the next release of the compiler so new features and improvements
10− handy for folks who want to build the most recent public
10+ get merged there. Most pull requests should target this branch!
11− release from source.
12
11
13− * The dev branch is where the most active development occurs.
12+ * [The stable branch](https://github.com/elm-lang/Elm/tree/stable) is for
14− It is the home of the next release of the compiler so new
13+ tagging previous releases and critical bug fixes. This branch is handy for
15− features and improvements get merged there.
14+ folks who want to build the most recent public release from source.
15+
16+If you are working on a fairly large feature, we will probably want to merge it
17+in as its own branch and do some testing before bringing it into the master
18+branch. This way we can keep releases of the master branch independent of new
19+features.
16
20
17## Opening a pull request
21## Opening a pull request
18
22
19−**Please open PRs against the [dev branch of
23+**Please open PRs against the [master branch of
20−Elm](http://github.com/evancz/elm/tree/dev) whenever possible.** Changes that
24+Elm](http://github.com/elm-lang/elm/tree/master) whenever possible.**
21−are compatible with the API of master will be merged to master as soon as
22−possible. Changes that affect Elm's API will be merged to master with a future
23−release of the compiler.
24
25
25−Note that changes in the master branch of [Elm](https://github.com/evancz/Elm/)
26+Note that changes in the master branch of [Elm](https://github.com/elm-lang/Elm/)
26are able to be compiled against the master branch of the [elm-lang.org
27are able to be compiled against the master branch of the [elm-lang.org
27−repo](https://github.com/evancz/elm-lang.org), and the dev branch of
28+repo](https://github.com/elm-lang/elm-lang.org), and the stable branch of
28−[Elm](https://github.com/evancz/Elm/) is able to be built with the dev branch of
29+[Elm](https://github.com/elm-lang/Elm/) is able to be built with the stable
29−the [elm-lang.org repo](https://github.com/evancz/elm-lang.org). Please make
30+branch of the [elm-lang.org repo](https://github.com/elm-lang/elm-lang.org).
30−sure that your changes maintain this compatibility.
31+Please make sure that your changes maintain this compatibility.
31
32
32## Licensing
33## Licensing
33
34
34−You should sign the [contributor agreement](ContributorAgreement.pdf)
35+You need to sign the [contributor agreement](ContributorAgreement.pdf)
35−and send it to <info@elm-lang.org> before opening your pull request.
36+and send it to <info@elm-lang.org> before opening your pull request.