diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2014-11-29 09:40:45 +0100 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2014-11-29 11:35:07 +0100 |
| commit | f3b833cf4c2f6d823b5c60c9273286ffa0959569 (patch) | |
| tree | ba242dfa95217bd95cc34a8f7db09dc03447f93d /CONTRIBUTING.md | |
| parent | 94517ac01ce3a00576d162dd05d4c25f0720790d (diff) | |
CONTRIBUTE.md: concentrate on the feature freeze and the roadmap
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e29d88c..c690e5d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,28 @@ -How to contribute -================= +Magit is currently in feature freeze. Please keep that in mind +when suggesting new features or submitting code contributions. -Contributions to Magit are highly welcome. Here are a few guidelines -that will help your patches hit upstream as soon as possible. +No new features will be implemented on the `master` branch, even +if they are "obviously not going to cause any problems" (this has +frequently turned out not to be true after all). Even for bugfixes +the treshhold is fairly high now; if fixing a bug which has existed +for years seems risky, then it won't be fixed now. -Making changes --------------- +Very few new features will be implemented on the `next` branch. +Basically only features that help *fixing* existing features might +be implemented despite the feature freeze. -Please make sure your commits are well-organized and "atomic" (hitting -a single well-defined target each). +If you feal that your issue or new feature is important enough to +violate the above restrictions, then please explicitly note that you +have read this and explain in your initial post why you feel an +exception should be made. That way I at least do not have to repeat +the above yet once more. -Please also make sure you check that byte-compilation completes -without errors or warnings, and that tests run without failures. +Please also consider whether your feature really is important enough +that implementing it now is justification enough to further delay the +release of the many new and many more improved features in `next`. - $ make lisp test +Also see the [Roadmap toward 2.1.0](https://github.com/magit/magit/issues/1645). -Bonus points if you add tests to cover the feature you're hacking. +Report issues [here](https://github.com/magit/magit/issues), +and open pull requests [here](https://github.com/magit/magit/pulls). -Submitting changes ------------------- - -Please submit your changes by opening a pull request on Magit's Github -repository at https://github.com/magit/magit/pulls. |