Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add git-flow instruction for contributions in readme #49

Merged
merged 1 commit into from
Oct 29, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

git clone --recursive http://github.com/syl20bnr/spacemacs .emacs.d

_Jump to [Install](#install) for more info_
_Jump to [Install](#install) for more info and
[here](#submitting-a-contribution-layer-upstream) for contribution guidelines_

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**
Expand Down Expand Up @@ -385,15 +386,15 @@ layer).

#### Submitting a contribution layer upstream

To submit a contribution layer just open a pull request :-)
`Spacemacs` uses the `git-flow` model, so you'll have to submit your
contributions and fixes as features or hotfixes within a pull-request to apply
against the `develop` branch.

It is **strongly** recommended to join a `README.md` file with your layer,
ideally this file should document the packages of your layer as well as the key
bindings associated with them.
It is recommended to join a `README.md` file with your layer, ideally this file
should document the packages of your layer as well as the key bindings
associated with them.

Note that by submitting a configuration layer you become the de facto maintainer
of it. For this reason it is advised to name your contribution with your Github
user name.
_Note: by submitting a configuration layer you become the maintainer of it._

#### Themes Megapack example

Expand Down