Contributing

We welcome feedback and proposed changes to this analysis project, as well as any bug reports and typos. Any permissible up-to-date data set upload is highly appreciated, as it will help us ensure our analysis can be amended to remain as timely as possible. The outline below indicates how to best proceed to communicate any such information.

Types of Contributions

Report Bugs

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.

Fixing typos

Small typos or grammatical errors in text documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Submit Feedback

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 animalsgonewild for local development.

Download a copy of animalsgonewild locally.
Install animalsgonewild using poetry:
```
$ poetry install
```
Use git (or similar) to create a branch for local development and make your changes:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.
Commit your changes and open a pull request.

Pull Request Guidelines

A Git branch need to be created for each pull request (PR) and one of the member will review and approve the request before megering it with main branch.

In brief:

Clone the repository locally.
Create a new branch.
Commit and push the change in that branch.
Submit pull request from that branch to the master branch.

Code of Conduct

Please note that the animalsgonewild project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.