Contributing
============

.. contents:: Table of Contents

.. _contributing:

Contributing to BIOINFO-guidelines
----------------------------------

This project is an attempt to write down some guidelines which need to be adopted
by people who works in our institution `IBBA-CNR <https://ibba.cnr.it>`_. Despite
this, the principles of those guidelines could be applied by everyone, so contributions
are welcome. Before starting to work on documentation, please follow those steps:

1. Open a `new issue <https://github.com/cnr-ibba/BIOINFO-guidelines/issues>`_
   in BIOINFO-guidelines repository, and get in touch with the developer: it's better
   to declare own intentions and talk with people before working on something that
   will never be included in such repository
2. Clone `this repository <https://github.com/cnr-ibba/BIOINFO-guidelines>`_
   in your GitHub account and clone it locally or where you
   plan to work on such documentation
3. Start a new branch, preferably as indicating the issue number of the issue you have
   opened on original repository (for example, if you created the issue #3, you should
   use ``issue-3`` as branch name)
4. Install ``conda`` (or ``miniconda``) if you don't have it yet. You could find
   it at `Anaconda website <https://www.anaconda.com/distribution/>`_
5. Install ``sphinx`` requirements by using::

      conda env create -f environment.yml

   Inside project directory. You could install them in a conda environment, if you prefer
6. Work on documentation by adding or modifying files according your need. Track
   your modifications using git
7. Before submitting modifications, please check that documentation compiles
   without errors and warnings by:

   .. code-block:: bash

      cd docs
      make clean
      make html

8. If documentation works as you intended, you could push your work on your GitHub
   account and start *from here* a new pull request
9. Give some times to the maintainers to review your code. If they requests you some
   modifications, please work in the same branch you used before and send your revision
   by committing in the same branch. Don't create a new branch or a new pull request,
   if you push your modifications on the same branch with a open pull request it will
   be updated accordingly

Thank you for your interest in BIOINFO-guidelines!