Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

31 lines (24 loc) · 1.32 KB

How to Contribute to This Project

Thank you so much for contributing to this project. Whether you are a beginner or an expert, there are many ways you can contribute to the Animal Kingdom Database.

You can contribute to this project in many ways, including:

  • Reporting a bug
  • Adding a new animal
  • Fixing a bug
  • Improving the documentation
  • Giving suggestions
  • Refactoring the code
  • etc. etc.

Open Issues

There are plenty of templates, each of which have guidelines. The common types of issues are:

  • Bug Report
  • New Animal
  • Animal Bio Update - write or update the bio/background for an animal
  • Frontend - Fix or add a feature/functionality on the frontend
  • Backend - Fix or add a feature/functionality on the backend

Pull Requests

If you are working on an issue that involves you working on the codebase of this project, you will need to do the following:

  1. Fork this repository
  2. Make a new branch for your changes
  3. Once you have committed your changes, do a pull request.

Once you have submitted a pull request, your code will be reviewed and eventually merged. You will be mentioned if any changes need to be made, so keep an eye out for your mentions in your notifications.

Thank you again and we hope to see you contributing to this project! If you have an questions, feel free to reach out to the maintainers.