aldryn/aldryn-boilerplate-bootstrap3

############
Contribution
############

.. note::

    You are very welcome improving this boilerplate for Aldryn and your
    everyday use, especially the documentation always needs love. Feel free to
    fork and send us pull requests and follow the guidelines from within this
    section.


***************
Code of Conduct
***************

- Ensure code validates against or own guidelines
- Write documentation about what you are doing
- If you are not sure, just ask - join our community **#aldryn** on `Freenode <http://freenode.net/>`_


*************
Documentation
*************

To extend and run the documentation, you will need
`Python <https://www.python.org/downloads/>`_ and
`Virtualenv <https://virtualenv.pypa.io/en/latest/installation.html>`_
installed on your computer. You also need
`Git <http://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
and a GitHub account obviously.

In addition, follow the steps underneath to get them running:

#. clone the repository using ``git clone https://github.com/aldryn/aldryn-boilerplate-bootstrap3.git``
#. navigate to the documentation through ``cd aldryn-boilerplate-bootstrap3/docs``
#. run ``make install`` to install additional requirements
#. run ``make run`` to let the server run

Now you can open **http://localhost:8000** on your favourite browser and start
changing the rst files within ``docs/``.

You need to be aware of
`reStructuredText <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_
to format the documentation properly.

.. admonition:: Guidelines
    :class: `important`

    - Always start paths with a ``/`` and leave the trailing slash.
    - Leave two spaces before a title.
    - Write "Django", "django CMS" or "Aldryn".
    - Write names properly: Sass, Bootstrap, JavaScript instead of sass (or SASS), bootstrap and javascript.
    - Additional guidelines from `django CMS
      <http://docs.django-cms.org/en/develop/contributing/contributing.html#documentation-markup>`_ apply.


*************
Pull Requests
*************

Before starting to work on issues or features, please mind the branching model:

- **master** is used for hotfix releases (1.1.x)
- **develop** is used for features and issues (1.x.x)

Everything that is merged to *develop* will be released within the next proper
release (1.x.x). Major releases (x.0.0) will have their own branches but are
always merged to *develop* before releasing to master.

A pull request needs the consent of two developers familiar with this repository
to be merged.


********
Releases
********

- Adapt the `CHANGELOG.rst <https://github.com/aldryn/aldryn-boilerplate-bootstrap3/blob/master/CHANGELOG.rst>`_
- Adapt `AUTHORS.rst <https://github.com/aldryn/aldryn-boilerplate-bootstrap3/blob/master/AUTHORS.rst>`_ if required
- Bump version in `boilerplate.json <https://github.com/aldryn/aldryn-boilerplate-bootstrap3/blob/master/boilerplate.json>`_
- Create a `GitHub tag <https://github.com/aldryn/aldryn-boilerplate-bootstrap3/tags>`_
- Add the release notes on the `GitHub tag <https://github.com/aldryn/aldryn-boilerplate-bootstrap3/releases>`_
- Build new tag on `readthedocs.org <https://readthedocs.org/projects/aldryn-boilerplate-bootstrap3/>`_
- Run ``bash tools/release.sh`` before release on `Aldryn <http://control.aldryn.com>`_
- Run ``aldryn boilerplate upload`` to release on `Aldryn <http://control.aldryn.com>`_
- Test, inform, present