|
| 1 | +# Contributing to Hoarder |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## How Can I Contribute? |
| 6 | + |
| 7 | + |
| 8 | +### Asking Questions |
| 9 | + |
| 10 | +If you have questions: |
| 11 | + |
| 12 | +* Use the GitHub Discussions Q&A section |
| 13 | +* Search existing discussions to see if your question has been answered |
| 14 | +* If not found, create a new discussion with a clear, descriptive title |
| 15 | + |
| 16 | + |
| 17 | +### Reporting Bugs |
| 18 | + |
| 19 | +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: |
| 20 | +* Create a new issue using the bug report template |
| 21 | +* Include a clear description and steps to reproduce |
| 22 | +* Wait for triage and labeling by maintainers |
| 23 | + |
| 24 | + |
| 25 | +### Suggesting Features |
| 26 | + |
| 27 | +For feature requests: |
| 28 | + |
| 29 | +* If you find a similar feature request, upvote it instead of creating a new one to help us prioritize it |
| 30 | +* Create a new issue using the feature request template |
| 31 | +* New features start with the `status/untriaged` label |
| 32 | + * If the feature request is approved, the maintainers will add the `status/approved` label and assign a priority to the issue |
| 33 | + * Other issues will get labeled with `status/icebox`. Issues in the icebox are not prioritized, until there's enough interest from the community |
| 34 | + |
| 35 | + |
| 36 | +### Working on Issues |
| 37 | + |
| 38 | +Before starting to work on an issue: |
| 39 | + |
| 40 | +* Prefer working on `status/approved` issues to make sure they get prioritized for the review |
| 41 | +* Comment on the issue to let others know you're working on it |
| 42 | +* Read the [development documentation](https://docs.hoarder.app/Development/setup) to get started |
| 43 | +* If you need help, you can find us in the #development channel in the [Hoarder Discord](https://discord.com/invite/NrgeYywsFh). |
| 44 | +* Once you're done, open a PR and wait for review. Try to include a screenshot of the change in the PR description. |
| 45 | + |
| 46 | +Please note that we're all volunteers. We'll aim to review your PR within a week from when they are opened. |
0 commit comments