git.iko.soy/elk
on 4bec310 help sign in
elk/CONTRIBUTING.md
36 lines 1.6 kB history raw
1# Contributing to Elm
3Thanks helping with the development of Elm! This document
4describes the basic standards for opening pull requests:
6## Branches
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!
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.
16If 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
18branch. This way we can keep releases of the master branch independent of new
19features.
21## Opening a pull request
23**Please open PRs against the [master branch of
24Elm](http://github.com/elm-lang/elm/tree/master) whenever possible.**
26Note that changes in the master branch of [Elm](https://github.com/elm-lang/Elm/)
27are able to be compiled against the master branch of the [elm-lang.org
28repo](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
30branch of the [elm-lang.org repo](https://github.com/elm-lang/elm-lang.org).
31Please make sure that your changes maintain this compatibility.
33## Licensing
35You need to sign the [contributor agreement](ContributorAgreement.pdf)
36and send it to <info@elm-lang.org> before opening your pull request.