Contribute to Cinemagoer!
-------------------------

Welcome!
~~~~~~~~

Thank you for your interest in contributing to Cinemagoer. This
contributor guide should help you get off to a good start.

We want to make contributing to this project as easy and transparent as
possible, whether it’s:

-  Reporting a bug
-  Submitting a patch
-  Proposing new features
-  And more!

`View our list of
Contributors <https://cinemagoer.readthedocs.io/en/latest/credits.html>`__,
which we thank for being a part of Cinemagoer.

GitHub Repository
~~~~~~~~~~~~~~~~~

We develop with GitHub. This is used as our code repository, where we
can track issues and accept pull requests.

To start using GitHub, `create your own
account <https://github.com/signup>`__.

Our home page for our repository is found here:
https://github.com/cinemagoer/cinemagoer

Bugs
~~~~

We use Github Issues to track issues.

`Visit our Issue
Tracker <https://github.com/cinemagoer/cinemagoer/issues>`__

Before filing any new issue, please check if it has been already
reported.

Please report all information needed to reproduce the error. Remember to
include: - error messages - stack tracebacks - URL (or name, or title)
of the movie/person page that generates the error (if available)

Patches
~~~~~~~

We use Github Pull Requests for submitting patches.

`View our Pull
Requests <https://github.com/cinemagoer/cinemagoer/pulls>`__

Patches can also be submitted to the development mailing list (see our
**Development Mailing List** section).

Development Mailing List
~~~~~~~~~~~~~~~~~~~~~~~~

imdbpy-devel@lists.sourceforge.net

The mailing list is also open to non-subscribers (anyone can send
emails) but is moderated by default: your first message needs to be
approved; if it’s on-topic, the succeeding ones will be automatically
accepted.

Translation
~~~~~~~~~~~

Want to help translate this project?

`Visit our Transifex
project <https://explore.transifex.com/davide_alberani/imdbpy/>`__.

Also, visit our Read the Docs page on `How to
translate. <https://cinemagoer.readthedocs.io/en/latest/devel/translate.html>`__

Environment Set Up
~~~~~~~~~~~~~~~~~~

Ready to contribute to the Cinemagoer package?

First, make a clone of the repository. `Instructions for how to do so
are provided by
Github <https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop>`__.

Next, follow our instructions on the `Read the Docs - Development
page <https://cinemagoer.readthedocs.io/en/latest/devel/index.html>`__,
to create a virtual environment and install Cinemagoer in editable mode
with extra packages.

You will then be able to make your contribution, and either submit it
via a Pull Request on Github or by sending in the patch to the
development mailing list.

Please create your own branch for each Pull Request you submit.
`Instructions on creating a branch by
Github <https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches>`__.

Additional Contributor Resources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  `Visit our development page on our
   webiste <https://cinemagoer.github.io/development/>`__
-  `Visit our Read the Docs
   pages <https://cinemagoer.readthedocs.io/en/latest/index.html>`__
-  `Visit the Open Source Guide by
   Github <https://opensource.guide/how-to-contribute/>`__
