============
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 the
`issue tracker <https://github.com/projecthamster/shell-extension/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"
is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~
Look through the GitHub issues for features.

Write Documentation
~~~~~~~~~~~~~~~~~~~
*Hamster-Shell-Extension* could always use more documentation, whether as part
of the official  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 <https://github.com/projecthamster/shell-extension/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 `hamster-shell-extension` for local
development.

For additional information on coding conventions and commit/PR best practices
please refer to the :doc:`styleguide <styleguide>`.

#. Fork `the repository <https://github.com/projecthamster/shell-extension/>`_
   on github.
#. Clone your fork locally::

    $ git clone git@github.com:your_name_here/hamster-shell-extension.git

#. Create a branch for local development::

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

   Now you can make your changes locally.

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

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

#. Submit a `Pull Request
   <https://github.com/projecthamster/shell-extension/pulls>`_ with your
   branch.

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. Add yourself to AUTHORS.rst.
