Add README for the issue tracker
This commit is contained in:
48
README.md
Normal file
48
README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Ditto: Issues and Feature Requests
|
||||
|
||||
Welcome, and thanks for helping make **Ditto** better.
|
||||
|
||||
Ditto is a collectibles inventory and customs compliance tool: scan your items,
|
||||
let it identify and price them, organize them into totes, and produce the
|
||||
paperwork when it is time to move or sell. This repository is **not** the source
|
||||
code. It is the front desk where you tell us what is broken and what you wish
|
||||
Ditto could do.
|
||||
|
||||
## File a report
|
||||
|
||||
Open a new issue and pick the form that fits:
|
||||
|
||||
- **Bug report** for something that is broken or behaving oddly.
|
||||
- **Feature request** for an idea or improvement.
|
||||
|
||||
> [New issue](https://gitea.parodia.dev/drwily/ditto-bugs/issues/new/choose)
|
||||
|
||||
You will need a Gitea account to post. It takes a moment and keeps the spam out.
|
||||
|
||||
## Before you file
|
||||
|
||||
A few seconds here saves everyone time:
|
||||
|
||||
1. **Search first.** Browse the [open issues](https://gitea.parodia.dev/drwily/ditto-bugs/issues)
|
||||
to see if someone already raised it. If so, add a comment or a thumbs-up
|
||||
rather than opening a duplicate.
|
||||
2. **One report per issue.** Two unrelated bugs in one issue are easy to lose.
|
||||
3. **Show, do not just tell.** Screenshots, the exact steps you took, and what
|
||||
you expected to see are the difference between a quick fix and a long
|
||||
guessing game.
|
||||
|
||||
## What happens next
|
||||
|
||||
Every report is read. We label it, ask follow-up questions if needed, and link
|
||||
it to the work as it happens. You will get a notification on the issue when its
|
||||
status changes, so keep an eye on the thread.
|
||||
|
||||
## Good to know
|
||||
|
||||
- This tracker holds **issues only**. There is no source code here.
|
||||
- Please keep reports civil and on topic.
|
||||
- Sensitive or security-related findings: do not post them publicly here.
|
||||
Contact the maintainer directly instead.
|
||||
|
||||
Thanks again for taking the time. Detailed reports make Ditto better for
|
||||
everyone.
|
||||
Reference in New Issue
Block a user