Contributing

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

Bug reports

When 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.

Documentation improvements

We are happy to receive contributions to our documentation. Please do suggest changes to the official explorepy docs and docstrings, or increase our web presence with blog posts and articles.

Feature requests and feedback

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

Development

To set up explorepy for local development:

  1. Fork explorepy (look for the “Fork” button).

2. Clone your fork locally

git clone git@github.com:USERNAME/explorepy.git

3. Create a branch for local development

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

4. Commit your changes and push your branch to GitHub

git add .
git commit -m "Detailed description of changes."
git push origin name-of-bugfix-or-feature

  1. Submit a pull request to the develop branch through the GitHub website.

Pull Request Guidelines

For a code review or feedback, create a pull request to the develop branch.

For merge approval:

  1. Update the documentation when appropriate.

  2. Add a note to CHANGELOG.rst about the changes.

  3. Add yourself to AUTHORS.rst.