First off, thank you for considering contributing to our project! This document outlines our contribution process and guidelines to make it easy for you to help improve this project.
If you have questions:
- Use the GitHub Discussions Q&A section
- Search existing discussions to see if your question has been answered
- If not found, create a new discussion with a clear, descriptive title
If in doubt, about whether a problem you're seeing is a bug or not, use the discussions Q&A section instead. If it turns out to be a bug, we'll promote it into an issue. If you're sure it's a bug:
- Create a new issue using the bug report template
- Include a clear description and steps to reproduce
- Wait for triage and labeling by maintainers
For feature requests:
- If you find a similar feature request, upvote it instead of creating a new one to help us prioritize it
- Create a new issue using the feature request template
- New features start with the
status/untriagedlabel- If the feature request is approved, the maintainers will add the
status/approvedlabel and assign a priority to the issue - Other issues will get labeled with
status/icebox. Issues in the icebox are not prioritized, until there's enough interest from the community
- If the feature request is approved, the maintainers will add the
Before starting to work on an issue:
- Prefer working on
status/approvedissues to make sure they get prioritized for the review - Comment on the issue to let others know you're working on it
- Read the development documentation to get started
- If you need help, you can find us in the #development channel in the Hoarder Discord.
- Once you're done, open a PR and wait for review. Try to include a screenshot of the change in the PR description.
Please note that we're all volunteers. We'll aim to review your PR within a week from when they are opened.