Skip to content
Browse files

Add more info on how the report a bug or contribute (ref ##128).

  • Loading branch information
saimn committed Sep 4, 2014
1 parent 9ed733b commit dcb91cbf604ae44ec2b0420fd34b8b2840b72594
Showing with 80 additions and 24 deletions.
  1. +0 −21
  2. +39 −0 CONTRIBUTING.rst
  3. +2 −3 Makefile
  4. +38 −0 docs/contribute.rst
  5. +1 −0 docs/index.rst

This file was deleted.

@@ -0,0 +1,39 @@
Filing issues

If you have an issue with sigal, the first step is to run::

sigal build -fd -n 1

to get diagnostic information (debug mode, only one core). If you can identify
an image or video that is causing the issue, you can create a new directory
containing only this image/video and rerun ``sigal build -fd -n 1``.

Then, put the output into a gist/pastebin, and fill an issue on github. You
can also write to the `mailing list`_ or try to get help via the ``#sigal`` IRC
channel on freenode.

How To Contribute

sigal is always open for suggestions and contributions by generous developers.
Here are a few tips to get you started.


- Obey `PEP 8`_ and `PEP 257`_.
- *Always* add tests and docs for your code.
- Add yourself to the AUTHORS file in an alphabetical fashion, and add your
name to the license header of the files you modify.
- Write `good commit messages`_.
- Ideally, squash_ your commits, i.e. make your pull requests just one commit.
- Use a branch, it will be easier to squash or rebase on upstream's master.

Thank you for considering to contribute to sigal !

.. _Mailing list:
.. _squash:
.. _PEP 8:
.. _PEP 257:
.. _good commit messages:
@@ -7,8 +7,7 @@ init:
pip install -r requirements.txt

cd docs && make html
@echo "\033[95m\n\nBuild successful! View the docs homepage at docs/_build/html/index.html.\n\033[0m"
make -C docs html

cat $(COLORBOX_PATH)/{base,skeleton,colorbox,style}.css | cssmin > $(COLORBOX_PATH)/style.min.css
@@ -27,4 +26,4 @@ publish:
python sdist upload
python bdist_wheel upload

.PHONY: colorbox galleria
.PHONY: colorbox galleria docs
@@ -0,0 +1,38 @@
Contributing guidelines

.. include:: ../CONTRIBUTING.rst

Setting up the development environment

Using a virtualenv_::

git clone
cd sigal
virtualenv venv
. venv/activate

Install sigal in development mode::

pip install -e .

Install additional dependencies for development (Sphinx, ...)::

pip install -r requirements.txt

Building the docs

- Run ``make docs`` (or ``make html`` in the ``docs/`` directory).

Running the test suite

- Run ``make test`` (or ``py.test``).
- Run ``make coverage`` to get the coverage report.
- Using tox_ you can also run the tests on multiple versions of python.

.. _tox:
.. _virtualenv:
@@ -13,4 +13,5 @@ Documentation

0 comments on commit dcb91cb

Please sign in to comment.
You can’t perform that action at this time.