.. _contributing:

***********************
Contributing to ``qha``
***********************

.. contents:: Table of contents:
   :local:

The package is hosted on `GitHub <https://github.com/MineralsCloud/qha>`_.


Where to start?
===============

All contributions, bug reports, bug fixes, documentation improvements,
enhancements, and ideas are welcome.

Please submit your issues `on GitHub issues <https://github.com/MineralsCloud/qha/issues>`_.
If you want to make a pull request, please read their official guide
`"HOWTO" <https://help.github.com/articles/creating-a-pull-request/>`_.


Environment
===========

Please install ``qha`` with command::

   $ pip install -e /path/to/qha/folder

after your download from `GitHub releases <https://github.com/MineralsCloud/qha/releases>`_.

Or you can just clone `the repo <https://github.com/MineralsCloud/qha>`_ directly by::

   $ git clone git@github.com:MineralsCloud/qha.git /somewhere/on/your/computer

And receive the update by::

   $ git pull


Contact
=======

If you have trouble with GitHub's issues and pull requests, please contact the maintainers
(`Sunny <mailto:qinxx197@umn.edu>`_ and `Qi <mailto:qz2280@columbia.edu>`_).
We will reply as soon as possible.