From 99f79b1faef99b0fbb42d31a1fa1277e9bd0f1b2 Mon Sep 17 00:00:00 2001 From: "Aaron K. Clark" Date: Mon, 18 May 2026 01:04:22 -0500 Subject: [PATCH] docs: GitHub + Gitea PR and issue templates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Issue and PR templates for both forges so contributors get the right scaffolding when they open a new ticket. Both formats land in the same PR; one set per forge: - `.github/PULL_REQUEST_TEMPLATE.md` (GitHub) - `.github/ISSUE_TEMPLATE/bug_report.md` - `.github/ISSUE_TEMPLATE/feature_request.md` - `.github/ISSUE_TEMPLATE/config.yml` — blanks disabled; "Security vulnerability" + "Codeberg mirror" surfaced as the contact links - `.gitea/PULL_REQUEST_TEMPLATE.md` (Codeberg mirror) - `.gitea/issue_template/bug_report.md` - `.gitea/issue_template/feature_request.md` PR template references the SECURITY.md path and the CONTRIBUTING.md pre-PR checklist. Issue templates ask for the operationally useful info (commit, Node version, Postgres version, deployment shape) up front so triage doesn't need a back-and-forth. Co-Authored-By: Claude Opus 4.7 (1M context) --- .gitea/PULL_REQUEST_TEMPLATE.md | 35 ++++++++++++++++++ .gitea/issue_template/bug_report.md | 44 +++++++++++++++++++++++ .gitea/issue_template/feature_request.md | 32 +++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 44 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 32 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 35 ++++++++++++++++++ 7 files changed, 236 insertions(+) create mode 100644 .gitea/PULL_REQUEST_TEMPLATE.md create mode 100644 .gitea/issue_template/bug_report.md create mode 100644 .gitea/issue_template/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.gitea/PULL_REQUEST_TEMPLATE.md b/.gitea/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..07f1247 --- /dev/null +++ b/.gitea/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ + + +## Summary + + + + +## Test plan + +- [ ] `npm run lint` clean +- [ ] `npm test` passes locally +- [ ] `npm run audit` clean (production deps) +- [ ] OpenAPI spec updated if endpoints / parameters / response shapes changed +- [ ] CHANGELOG entry added under `[Unreleased]` +- [ ] + + +## Review notes (optional) + + + + +Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/ diff --git a/.gitea/issue_template/bug_report.md b/.gitea/issue_template/bug_report.md new file mode 100644 index 0000000..36637ad --- /dev/null +++ b/.gitea/issue_template/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Something is broken or behaves unexpectedly +title: '' +labels: bug +assignees: '' +--- + + + +## Summary + + + + +## To reproduce + +1. +2. +3. + +### Expected + + +### Actual + + + +## Environment + +- TimeTrackerAPI commit / tag: +- Node version: +- Postgres version: +- Deployment shape: + + +## Anything else? + + + +Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/ diff --git a/.gitea/issue_template/feature_request.md b/.gitea/issue_template/feature_request.md new file mode 100644 index 0000000..4178779 --- /dev/null +++ b/.gitea/issue_template/feature_request.md @@ -0,0 +1,32 @@ +--- +name: Feature request +about: Propose new functionality or an API change +title: '' +labels: enhancement +assignees: '' +--- + +## Problem + + + + +## Proposed approach + + + + +## Alternatives considered + + + + +## Migration notes + + + + +Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/ diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..36637ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Something is broken or behaves unexpectedly +title: '' +labels: bug +assignees: '' +--- + + + +## Summary + + + + +## To reproduce + +1. +2. +3. + +### Expected + + +### Actual + + + +## Environment + +- TimeTrackerAPI commit / tag: +- Node version: +- Postgres version: +- Deployment shape: + + +## Anything else? + + + +Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/ diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..dd978fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright 2026 Aaron K. Clark +# +# GitHub picks up this file under .github/ISSUE_TEMPLATE/ and uses it +# to render the "additional links" section on the New Issue picker. + +blank_issues_enabled: false +contact_links: + - name: Security vulnerability + url: https://github.com/CryptoJones/TimeTrackerAPI/security/advisories/new + about: Report a security vulnerability privately. NEVER open a public issue. + - name: Codeberg mirror + url: https://codeberg.org/CryptoJones/TimeTrackerAPI/issues + about: Issues filed on the Codeberg mirror are equally accepted. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..4178779 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: Feature request +about: Propose new functionality or an API change +title: '' +labels: enhancement +assignees: '' +--- + +## Problem + + + + +## Proposed approach + + + + +## Alternatives considered + + + + +## Migration notes + + + + +Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..07f1247 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ + + +## Summary + + + + +## Test plan + +- [ ] `npm run lint` clean +- [ ] `npm test` passes locally +- [ ] `npm run audit` clean (production deps) +- [ ] OpenAPI spec updated if endpoints / parameters / response shapes changed +- [ ] CHANGELOG entry added under `[Unreleased]` +- [ ] + + +## Review notes (optional) + + + + +Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/