CONTRIBUTING.md

Contributing to this repository

Getting started

Before you begin:

• This project is powered by Python. TODO add resource for learning Python.
• Have you read the code of conduct?
• Check out the existing issues.
• Familiarize yourself with the project's design patterns.

Don't see your issue? Open one

If you spot something new, open an issue. We'll use the issue to have a conversation about the problem you want to fix.

Ready to make a change? Fork the repo

Fork using GitHub Desktop:

• Getting started with GitHub Desktop will guide you through setting up Desktop.
• Once Desktop is set up, you can use it to fork the repo!

Fork using the command line:

• Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Make your update:

Make your changes to the file(s) you'd like to update.

Open a pull request

When you're done making changes and you'd like to propose them for review, open your PR (pull request).

Submit your PR & get it reviewed

• Once you submit your PR, others will review it with you.
• After that, we may have questions, check back on your PR to keep up with the conversation.
• Did you have an issue, like a merge conflict? Check out GitHub's git tutorial on how to resolve merge conflicts and other issues.

Your PR is merged!

Congratulations! ✨

Once your PR is merged, you will be listed as a contributor in the contributor chart.

Attribution

This CONTRIBUTING.md is adapted from the GitHub Docs version.