git.iko.soy/elk
on b00a8cb help sign in
elk/CONTRIBUTING.md
35 lines 1.4 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 of Elm is for tagging previous releases
9 and non-breaking changes, like bug fixes. This branch is
10 handy for folks who want to build the most recent public
11 release from source.
13 * The dev branch is where the most active development occurs.
14 It is the home of the next release of the compiler so new
15 features and improvements get merged there.
17## Opening a pull request
19**Please open PRs against the [dev branch of
20Elm](http://github.com/evancz/elm/tree/dev) whenever possible.** Changes that
21are compatible with the API of master will be merged to master as soon as
22possible. Changes that affect Elm's API will be merged to master with a future
23release of the compiler.
25Note that changes in the master branch of [Elm](https://github.com/evancz/Elm/)
26are able to be compiled against the master branch of the [elm-lang.org
27repo](https://github.com/evancz/elm-lang.org), and the dev branch of
28[Elm](https://github.com/evancz/Elm/) is able to be built with the dev branch of
29the [elm-lang.org repo](https://github.com/evancz/elm-lang.org). Please make
30sure that your changes maintain this compatibility.
32## Licensing
34You should sign the [contributor agreement](ContributorAgreement.pdf)
35and send it to <info@elm-lang.org> before opening your pull request.