.. highlight:: shell

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

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

ABBA Python consists of a simple python wrapper over ABBA in Java:
https://github.com/BIOP/ijp-imagetoatlas

If the error is related to the Java part, you can report bugs at https://github.com/BIOP/ijp-imagetoatlas/issues

If the error is related to the python part, you can report bugs at https://github.com/BIOP/abba_python/issues.

If you are unsure, you can post your issue on https://forum.image.sc. If ABBA runs, it is even advised to use `Help > [ABBA] Ask for help in the forum` this command will include some local installation data.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

ABBA Python could always use more documentation. The documentation is currently in the `gh-pages` branch of https://github.com/BIOP/ijp-imagetoatlas

Submit Feedback - Ask for feature
~~~~~~~~~~~~~~~

The best way to submit feedback is through this google form: https://docs.google.com/forms/d/1PyX9XOeYJ0Ao-Ydxybn7uyZnpo-0hWjGQfn_8-hBOPw

You can also file an issue at https://github.com/nicoKiaru/ijp-imagetoatlas/issues

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions are welcome :)

TODO! Deploying (not implemented yet)
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
