Skip to content

Commit

Permalink
Convert documentation to publishable format
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBB authored and syl20bnr committed Nov 2, 2015
1 parent 9c7c148 commit 13c5b1d
Show file tree
Hide file tree
Showing 111 changed files with 1,768 additions and 1,860 deletions.
59 changes: 29 additions & 30 deletions doc/CONTRIBUTE.org
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
* Contribute to Spacemacs

** Table of Contents :TOC@4:
- [[#contribute-to-spacemacs][Contribute to Spacemacs]]
- [[#pull-request-guidelines][Pull Request Guidelines]]
- [[#ideally-and-for-simple-prs][Ideally and for /simple/ PRs:]]
- [[#for-complex-pull-requests][For complex pull requests:]]
- [[#getting-help][Getting Help]]
- [[#submitting-a-configuration-layer][Submitting a configuration layer]]
- [[#testing][Testing]]
- [[#submitting-a-banner][Submitting a banner]]
- [[#credits][Credits]]
- [[#license][License]]
- [[#file-header][File header]]
- [[#author-of-a-contribution-layer][Author of a contribution layer]]
- [[#contributor-of-a-contribution-layer][Contributor of a contribution layer]]

** Pull Request Guidelines
#+SETUPFILE: theme-readtheorg.setup

* Contribute to Spacemacs :TOC_4_org:noexport:
- [[Pull Request Guidelines][Pull Request Guidelines]]
- [[Ideally and for /simple/ PRs:][Ideally and for /simple/ PRs:]]
- [[For complex pull requests:][For complex pull requests:]]
- [[Getting Help][Getting Help]]
- [[Submitting a configuration layer][Submitting a configuration layer]]
- [[Testing][Testing]]
- [[Submitting a banner][Submitting a banner]]
- [[Credits][Credits]]
- [[License][License]]
- [[File header][File header]]
- [[Author of a contribution layer][Author of a contribution layer]]
- [[Contributor of a contribution layer][Contributor of a contribution layer]]

* Pull Request Guidelines
Spacemacs branch model is inspired from the [[http://nvie.com/posts/a-successful-git-branching-model/][git-flow]] model:
You'll have to submit your contributions and fixes within a pull-request to
apply against the =develop= branch.

/PR = pull request/

*** Ideally and for /simple/ PRs:
** Ideally and for /simple/ PRs:
- branch from =develop=
- one topic per PR
- one commit per PR
Expand All @@ -35,19 +34,19 @@ apply against the =develop= branch.
Those PRs are /fast-forwarded/ whenever it's possible and
/cherry-picked/ otherwise (most likely they will be cherry-picked).

*** For complex pull requests:
** For complex pull requests:
- squash only the commits with uninteresting changes like typos, syntax
fixes, etc... and keep the important and /isolated/ steps in
different commits.

Those PRs are /merged/ and explicitly /not fast-forwarded/.

*** Getting Help
** Getting Help
If you have any question on this process, join the [[https://gitter.im/syl20bnr/spacemacs][gitter
chatroom]] and ask your questions there. It will be a pleasure to help you to
contribute!

** Submitting a configuration layer
* Submitting a configuration layer
Contributed configuration layers are stored in the =layers= folder. The
=layers= folder also contains categories prefixed with =+= to put your
layers in. For example a layer for a language would go in the
Expand All @@ -62,9 +61,9 @@ It is recommended to join a =README.org= file with your layer:
- if a logo exists for the layer you can add it at the top of the =README.org=
before the TOC. The maximum recommended height is 200 pixels.

Please read the [[LAYERS.org][tips for writing layers]] first.
Please read the [[file:LAYERS.org][tips for writing layers]] first.

** Testing
* Testing
Tests live in the =tests= folder, with a folder structure corresponding to the
rest of the repository.

Expand Down Expand Up @@ -104,7 +103,7 @@ To add tests for a layer, do the following:

Spacemacs is lacking tests, so contributions are welcome.

** Submitting a banner
* Submitting a banner
The startup banner is by default randomly chosen among a pool of banners
each time Spacemacs starts. Banners are located in directory
=~/.emacs.d/core/banners=.
Expand All @@ -114,16 +113,16 @@ If you have some ASCII skills you can submit your artwork!
You are free to choose a reasonable height size but the width size
should be around 75 characters.

** Credits
*** License
* Credits
** License
The license is GPLv3 for all parts specific to Spacemacs, this
includes: - the initialization and core files - all the layer files.

For files not belonging to Spacemacs like extensions and libraries,
refer to the header file. Those files should not have an empty header,
please report any file imported in Spacemacs without a proper header.

*** File header
** File header
Template:

#+BEGIN_EXAMPLE
Expand All @@ -140,14 +139,14 @@ Template:
;;; License: GPLv3
#+END_EXAMPLE

*** Author of a contribution layer
** Author of a contribution layer
In the file header: - change =NAME= to the name of the layer, - change
the default author name =Sylvain Benner= to your name, - do not remove
the line: =;; Copyright (c) 2012-2014 Sylvain Benner= - modify the
second copyright line by replacing the default name and dates, *keep*
=& Contributors= in this line, - other lines should not be modified

*** Contributor of a contribution layer
** Contributor of a contribution layer
You should not modify any header file. A very cool way to show your
contributions will be available in Spacemacs at some point, /Stay
Tuned/.
Loading

0 comments on commit 13c5b1d

Please sign in to comment.