diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..62e9cc0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: Bug report +description: Report something that isn't working as expected +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for filing a bug. Please attach a minimal PDF that reproduces + the issue where possible (redact sensitive content first) — most + pdfdebug bugs are hard to fix without a sample file. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A clear description of the bug — what you observed. + placeholder: When I opened this PDF and clicked …, the app … + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce + description: Minimal steps so we can see it too. + placeholder: | + 1. Open '...' + 2. Click on '...' + 3. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected vs. actual + description: What you expected to happen, and what actually happened instead. + validations: + required: true + - type: dropdown + id: surface + attributes: + label: Where does this happen? + options: + - Desktop GUI + - CLI + - PDF parsing / inspection (pdfcore) + - Build / packaging + - Other + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: pdfdebug version or commit — the release tag, or `pdfdebug --version`. + placeholder: v0.4.0 + validations: + required: true + - type: textarea + id: context + attributes: + label: Anything else? + description: OS/platform, a sample PDF (redacted if needed), screenshots, or CLI output all help. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..950f8b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +# Maintainers still file rich free-form issues — keep the blank option. +blank_issues_enabled: true +contact_links: + - name: Report a security vulnerability + url: mailto:security@unidoc.io + about: Do NOT open a public issue for security problems. Email security@unidoc.io directly. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..6cece73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,25 @@ +name: Feature request +description: Suggest an improvement or a new capability +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem / motivation + description: What are you trying to do, and what's getting in the way? Lead with the why, not the solution. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed solution + description: What you'd like to see happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Other approaches you thought about, and why they fall short. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3369617 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +## Description and links + + + +## Technical changes + + + +## Considerations + + + +## How was this tested? + + + +## What could go wrong? + + + +## Screenshots/videos (if appropriate) + +## Checklist + +- [ ] Tests pass locally +- [ ] I targeted the `dev` branch, not `master`