Contribute#

Thank you for your interest in contributing to cca-zoo! Your contributions are welcome and appreciated. Every little bit helps, and credit will always be given.

There are many ways to contribute to this project:

Types of Contributions#

Report Bugs#

If you encounter a bug or an error while using cca-zoo, please report it on the GitHub issue tracker: jameschapman19/cca_zoo#issues

When reporting a bug, please include the following information:

  • Your operating system name and version.

  • The version of cca-zoo and its dependencies that you are using.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug, preferably with a minimal code example.

Fix Bugs#

You can also help by fixing existing bugs. You can browse the GitHub issues for bugs that are tagged with “bug” and “help wanted”. Feel free to pick any bug that interests you and submit a pull request with your fix.

Implement Features#

You can also help by implementing new features or enhancing existing ones. You can browse the GitHub issues for features that are tagged with “enhancement” and “help wanted”. Feel free to pick any feature that interests you and submit a pull request with your implementation.

Write Documentation#

Good documentation is crucial for any project. You can help by improving the existing documentation or writing new documentation for cca-zoo. The documentation is hosted at cca-zoo.readthedocs.io/en/latest/ and the source files are in the docs folder. You can also add example notebooks in the tutorial notebooks folder to demonstrate how to use cca-zoo for various tasks.

Submit Feedback#

We would love to hear your feedback and suggestions on how to improve cca-zoo. The best way to send feedback is to file an issue at jameschapman19/cca_zoo#issues

If you are proposing a new feature, please:

  • Explain in detail how it would work and what problem it would solve.

  • Keep the scope as narrow as possible, to make it easier to implement and maintain.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!#

Ready to contribute? Here’s how to set up cca-zoo for local development.

  1. Fork the cca-zoo repo on GitHub. This will create a copy of the repo under your GitHub account.

  2. Clone your fork locally on your computer:

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

    This will create a folder called cca_zoo with the project files.

  3. Create a branch for local development:

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

    This will create a new branch where you can make your changes locally. Choose a descriptive name for your branch that reflects what you are working on.

  4. Make your changes and commit them to your branch:

    $ git add .
$ git commit -m "Your detailed description of your changes."

    This will stage and save your changes to your branch. Write a clear and concise commit message that explains what you have done and why.

  5. Push your branch to GitHub:

    $ git push origin name-of-your-bugfix-or-feature

    This will upload your branch and its commits to your fork on GitHub.

  6. Submit a pull request through the GitHub website.

    This will open a page where you can compare your branch with the main branch of the original repo and request that your changes be merged into it. Write a clear and concise title and description for your pull request that explains what you have done and why. Wait for the project maintainers to review your pull request and provide feedback or approval.