=================
How to Contribute
=================

.. contents::

Tips for working with restructured text
=======================================

.. toctree::
        :maxdepth: 2

        test
        test_markdown.md         

Improving the docs
==================

Changing one file
-----------------

Small changes can be made by editing files on github directly. This is what to 
do if you need to make a change to only a single file.

1) Choose Edit on Github

.. image:: ../images/edit_on_github.gif
        :width: 640

2) Make your change. 
3) Commit as a branch

.. image:: ../images/commit_as_a_branch.gif
        :width: 640

4) Create a pull request to ``master``.

.. image:: ../images/create_a_pull_request.gif
        :width: 640

5) Hit the green button to merge that pull request and then delete your branch.


.. note:: 
        Docs will be built and published immediately. The process takes about
        three minutes. Watch the Juice Slack #ci-cd channel for success 
        notifications.

Adding Todos
------------

If you see something that requires specific improvement but don't have the 
knowledge or time to handle yourself, you can add a todo directive.

This looks like this:

.. code-block:: none

        .. todo:: Show screenshots of the different options.

All todos show up on the list below.

Bigger changes
--------------

If you're working with more than one file or adding images, you'll need to 
clone the docs and create a PR. Use the juicebox-docs readme to get started.

Todos
=====

.. todolist::