============
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
~~~~~~~~~~~

Report bugs at https://github.com/robertopreste/HmtNote/issues.

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
~~~~~~~~~~~~~~~~~~~

HmtNote could always use more documentation, whether as part of the
official HmtNote docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/robertopreste/HmtNote/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 :)


Get Started!
------------

Ready to contribute? Here's how to set up `hmtnote` for local development.

1. Fork the `hmtnote` repo on GitHub.
2. Clone your fork locally:

.. code-block:: console

    $ git clone git@github.com:your_name_here/HmtNote.git

3. Install your local copy into a virtualenv. You can use Python's `virtualenv` to create a Python 3
virtual environment and then install the requirements:

.. code-block:: console

    $ virtualenv -p python3.6 venv
    $ source venv/bin/activate
    $ pip install -r requirements_dev.txt
    $ python setup.py develop  # or pip install -e .

4. Create a branch for local development:

.. code-block:: console

    $ git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

5. When you're done making changes, check that your changes pass `flake8` and the
   tests, including testing other Python versions with `tox`:

.. code-block:: console

    $ flake8 hmtnote tests
    $ python setup.py test  # or py.test or pytest
    $ tox

   Your virtualenv should already have `flake8` and `tox` installed if you followed step 3,
   otherwise just `pip install` them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

.. code-block:: console

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.


Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
   your new functionality into a function with a docstring, and add the
   feature to the list in README.rst.
3. The pull request should work for Python 3.5 and 3.6, and for PyPy. Check
   https://travis-ci.org/robertopreste/HmtNote/pull_requests
   and make sure that the tests pass for all supported Python versions.


Tips
----

To run a subset of tests:

.. code-block:: console

    $ pytest tests.test_hmtnote


Deploying
---------

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

.. code-block:: console

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

Travis will then deploy to PyPI if tests pass.
