diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2013-12-11 16:08:56 +0100 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2013-12-11 16:08:56 +0100 |
| commit | 22666b2328165943c2d554cfafc78418643f66cd (patch) | |
| tree | 1b73d1642276dd7df473a43472bc7dda8411fd41 /CONTRIBUTING.md | |
| parent | 6f31703a1d076e3b62da5f9e56febb67e1f93ef5 (diff) | |
CONTRIBUTING.md: accept reality
Instead of describing Utopia, describe the here and now. Some of the
removed information might come back later, when it actually matches
reality.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 31 |
1 files changed, 4 insertions, 27 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6dc39c4..e29d88c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,44 +4,21 @@ How to contribute Contributions to Magit are highly welcome. Here are a few guidelines that will help your patches hit upstream as soon as possible. -Branching scheme ----------------- - -Magit uses three main branches for its lifecyle: `maint`, `master` and -`next`. - -* `maint` contains the set of patches that will definitely make it - into the next minor release. -* `master` contains the set of patches that will highly likely make it - into the next major release. -* `next` contains patches that necessitate some additional - checks/improvements before they're integrated into a release. - Making changes -------------- -A good practice is to create a topic branch off Magit, from the branch -you target for *final* inclusion. This should *always* be either -`maint` or `master`. - -If you branch off `next`, you'll only put more overhead on the -maintainer's shoulders, and the integration will suffer from -additional delays. - Please make sure your commits are well-organized and "atomic" (hitting a single well-defined target each). Please also make sure you check that byte-compilation completes without errors or warnings, and that tests run without failures. + $ make lisp test + Bonus points if you add tests to cover the feature you're hacking. Submitting changes ------------------ -The preferred way of submitting your changes is to open a pull request -on the central Magit Github repository -(https://github.com/magit/magit). - -Alternately, you can send your patches to the Magit mailing list -(magit@googlegroups.com), using `git send-email`. +Please submit your changes by opening a pull request on Magit's Github +repository at https://github.com/magit/magit/pulls. |