From 70a76abf7aa1b495f05cad37692bd2dbd77150ed Mon Sep 17 00:00:00 2001 From: Matt Hills Date: Sat, 31 Oct 2026 21:34:18 -0400 Subject: [PATCH] Add bug report and feature request issue forms --- .github/ISSUE_TEMPLATE/bug_report.yml | 72 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 33 ++++++++++ CONTRIBUTING.md | 2 +- 4 files changed, 111 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..921585d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,72 @@ +name: Bug report +description: Something in Papercase isn't working as it should +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug. Please **don't include real document details** (names, numbers, dates of birth) or screenshots of your documents. Use made-up examples instead. + + Found a security issue? Please [report it privately](https://github.com/mattintech/papercase/security/advisories/new) instead. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What went wrong, and what did you expect to happen instead? + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + placeholder: | + 1. Open a folder + 2. Tap ... + 3. See ... + validations: + required: true + - type: input + id: version + attributes: + label: Papercase version + description: "Tap the gear icon, then About." + placeholder: "1.2.1" + validations: + required: true + - type: dropdown + id: source + attributes: + label: Where did you install it from? + options: + - Google Play + - GitHub release + - Built from source + validations: + required: true + - type: input + id: device + attributes: + label: Device and Android version + placeholder: "Pixel 8, Android 16" + validations: + required: true + - type: dropdown + id: area + attributes: + label: Which part of the app? + options: + - Locker and documents + - Folders + - Adding photos, scanning or cropping + - Unlocking (fingerprint or PIN) + - Phone-to-phone transfer + - Backups (export, import or automatic) + - Passphrase or Quick Settings tile + - Expiry reminders + - Settings or appearance + - Something else + - type: textarea + id: extra + attributes: + label: Anything else? + description: How often it happens, whether it started after an update, or screenshots of the problem (not of your documents). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..d4687b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Report a security vulnerability + url: https://github.com/mattintech/papercase/security/advisories/new + about: Please report security issues privately, not as a public issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..dcd28f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Suggest an improvement or a new feature +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thanks for the idea. Papercase is offline and private by design, so suggestions that need accounts, cloud servers or analytics are unlikely to be added. + - type: textarea + id: problem + attributes: + label: What problem would this solve? + description: Describe what you're trying to do and what gets in the way today. + validations: + required: true + - type: textarea + id: idea + attributes: + label: What would you like to happen? + description: How you imagine it working. Sketches or examples from other apps are welcome. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Anything you've tried instead? + description: Workarounds you use now, or other ways it could be solved. + - type: checkboxes + id: contribute + attributes: + label: Contributing + options: + - label: I'd like to work on this myself (please wait for a reply before starting, see CONTRIBUTING.md) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5176b67..28aff84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for wanting to help! Papercase handles people's most sensitive documents, ## 1. Open an issue first -Before you write code, [open an issue](https://github.com/mattintech/papercase/issues/new) describing what you'd like to change and why: +Before you write code, [open an issue](https://github.com/mattintech/papercase/issues/new/choose) using the bug report or feature request form, describing what you'd like to change and why: - **Bug:** what you did, what you expected, what happened, your device and Android version. Please don't include real document details or screenshots of your documents. - **Feature or change:** the problem it solves and roughly how you'd approach it.