Skip to content

chore: add PR and issue templates#2

Merged
unidoc-anom merged 1 commit into
devfrom
chore/add-pr-and-issue-templates
Jul 14, 2026
Merged

chore: add PR and issue templates#2
unidoc-anom merged 1 commit into
devfrom
chore/add-pr-and-issue-templates

Conversation

@gunnsth

@gunnsth gunnsth commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Description and links

pdfdebug had no PR template and no structured issue templates, unlike newer UniDoc repos (e.g. isms). This adds both so contributions follow a consistent shape.

Technical changes

  1. Added .github/pull_request_template.md, adapted from unipdf-src's internal template with JIRA links and the User-Guide-doc-gate dropped (don't apply to a small public repo).
  2. Added .github/ISSUE_TEMPLATE/bug_report.yml and feature_request.yml as GitHub issue forms, scoped to pdfdebug's actual surfaces (GUI/CLI/pdfcore/build) rather than copied verbatim from another repo.
  3. Added .github/ISSUE_TEMPLATE/config.yml to keep the blank-issue option and redirect security reports to security@unidoc.io, matching what CONTRIBUTING.md already documents.

Considerations

Went with GitHub's newer YAML issue-forms format (structured fields) rather than unipdf/unioffice's plain markdown templates, since it's the more current convention internally (isms) and gives better-triaged bug reports. unipdf/unioffice remain on the older style for now — a possible follow-up if we want the public repos consistent.

How was this tested?

Templates-only change, no code affected.

What could go wrong?

Low risk — these only affect the GitHub UI forms shown when opening a new issue/PR, no runtime behavior.

Screenshots/videos (if appropriate)

N/A — will confirm the forms render correctly by opening a test issue/PR in the GitHub UI after merge.

Checklist

  • Tests pass locally (n/a, docs/config only)
  • I targeted the dev branch, not master

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds standardized GitHub contribution templates to pdfdebug so incoming PRs and issues are consistently structured and better triaged.

Changes:

  • Added a repository PR template covering description, testing, risk, and checklist items.
  • Added structured GitHub Issue Forms for bug reports and feature requests.
  • Added Issue Template configuration enabling blank issues and routing security reports to security@unidoc.io.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
.github/pull_request_template.md Introduces a consistent PR submission structure and checklist (incl. dev vs master guidance).
.github/ISSUE_TEMPLATE/bug_report.yml Adds a structured bug report form with repro, expected/actual, surface selection, and version capture.
.github/ISSUE_TEMPLATE/feature_request.yml Adds a structured feature request form capturing motivation, solution, and alternatives.
.github/ISSUE_TEMPLATE/config.yml Enables blank issues and adds a security contact link to email security reports.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@unidoc-anom
unidoc-anom merged commit e37f7a3 into dev Jul 14, 2026
4 checks passed
@unidoc-anom
unidoc-anom deleted the chore/add-pr-and-issue-templates branch July 14, 2026 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants