Thank you for investing your time in contributing to our project! Any contribution you make will be reflected in one of Mauve's upcoming releases. ✨
Read our Code of Conduct ⚖️ to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
To navigate our codebase with confidence, see the wiki. 🎊 For more information on how we style our code files, see the styling guide.
If you identify a problem with the project, search to determine if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a pull request with the proposed changes.
Labels can help you find an issue you'd like to help with.
- The
help wantedlabel is for problems or updates that anyone in the community can start working on. - The
good first issuelabel is for problems or updates we think are ideal for beginners.
This contributing document is adapted from the GitHub Docs contributing file.