diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2013-05-20 22:25:08 +0200 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2013-05-25 21:31:39 +0200 |
| commit | 7d44d929a3eb364135341a19c8b38be7b0b9613e (patch) | |
| tree | 2e3f8d112e850541713562b7bf2e5cb2ba12460e /CONTRIBUTING.md | |
| parent | 34bff355d5b9f63f090695a8a119022764baf25c (diff) | |
improve installation instructions and other docs
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 55 |
1 files changed, 31 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a0206c..6dc39c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,40 +1,47 @@ -# How to contribute +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. +Contributions to Magit are highly welcome. Here are a few guidelines +that will help your patches hit upstream as soon as possible. -## Branching scheme +Branching scheme +---------------- -Magit uses 3 main branches for its lifecyle: `maint`, `master` and `next`. +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. +* `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 +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`. +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. +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 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. +Please also make sure you check that byte-compilation completes +without errors or warnings, and that tests run without failures. Bonus points if you add tests to cover the feature you're hacking. -## Submitting changes +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). +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`. |