From ac50007623e5921640baddbeeb56fea1022d1b30 Mon Sep 17 00:00:00 2001 From: "moxie-docs[bot]" <287554421+moxie-docs[bot]@users.noreply.github.com> Date: Mon, 8 Jun 2026 02:21:46 +0000 Subject: [PATCH] docs: 7 files --- .github/PULL_REQUEST_TEMPLATE/bugfix.md | 14 +++++++++++++ .github/PULL_REQUEST_TEMPLATE/community.md | 22 +++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/docs.md | 15 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE/hotfix.md | 16 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE/ops.md | 13 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/web_app.md | 23 ++++++++++++++++++++++ .github/pull_request_template.md | 15 ++++++++++++++ 7 files changed, 118 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/bugfix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/community.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/docs.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/hotfix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/ops.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/web_app.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md new file mode 100644 index 0000000..126e8ff --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -0,0 +1,14 @@ +## What was broken * +_Describe the user-visible symptom and when it started._ + +## Root cause * +_What was actually wrong in the code?_ + +## How to verify the fix +_Steps a reviewer can run to confirm the fix._ + +## Regression check +- [ ] Added a test +- [ ] Tested affected flows manually + +* Required sections — Moxie will flag if missing on alignment. diff --git a/.github/PULL_REQUEST_TEMPLATE/community.md b/.github/PULL_REQUEST_TEMPLATE/community.md new file mode 100644 index 0000000..36d8623 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/community.md @@ -0,0 +1,22 @@ +## Description * +_What this PR does and why. Reviewers should be able to understand the change without reading the diff._ + +## Linked issue or discussion +**Issue / Discussion:** __ _(Paste `Fixes #123` or a discussion link. Skip for trivial changes.)_ + +## Type of change * +- [ ] Bug fix (non-breaking) +- [ ] New feature (non-breaking) +- [ ] Breaking change +- [ ] Documentation update +- [ ] Internal refactor + +## Quality checks +- [ ] Added or updated tests covering this change +- [ ] Ran the project's verified commands locally +- [ ] Updated documentation where the public API changed + +## Breaking changes +_Only fill in if this PR introduces a breaking change. Describe the migration path._ + +* Required sections — Moxie will flag if missing on alignment. diff --git a/.github/PULL_REQUEST_TEMPLATE/docs.md b/.github/PULL_REQUEST_TEMPLATE/docs.md new file mode 100644 index 0000000..3457be7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/docs.md @@ -0,0 +1,15 @@ +## Source changes reviewed * +_Which PRs or commits prompted this update?_ + +## Docs updated * +_What changed and where it lives now._ + +## Source PR or commit +**Link:** __ _(Optional — paste the PR or commit URL.)_ + +## Reviewer checklist +- [ ] Links resolve +- [ ] No stale screenshots +- [ ] Examples still run + +* Required sections — Moxie will flag if missing on alignment. diff --git a/.github/PULL_REQUEST_TEMPLATE/hotfix.md b/.github/PULL_REQUEST_TEMPLATE/hotfix.md new file mode 100644 index 0000000..d824aa6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/hotfix.md @@ -0,0 +1,16 @@ +## Hotfix +> Minimize scope. No opportunistic cleanup. Open follow-up PRs for anything else. + +## Linked incident * +**Incident:** __ _(Status page, oncall ticket, or war room link.)_ + +## What's the fix * +_Be specific. One line is fine._ + +## Post-merge verification * +_How you'll confirm the fix in production._ + +## Follow-ups to file +- [ ] (add follow-up tasks here) + +* Required sections — Moxie will flag if missing on alignment. diff --git a/.github/PULL_REQUEST_TEMPLATE/ops.md b/.github/PULL_REQUEST_TEMPLATE/ops.md new file mode 100644 index 0000000..37aa861 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/ops.md @@ -0,0 +1,13 @@ +## Operational change * +_What's changing in the system._ + +## Risk and rollback * +_Blast radius and how to revert._ + +## Verification +_How you confirmed the change works in the target environment._ + +## Reminder +> Coordinate with on-call before merging during business hours. + +* Required sections — Moxie will flag if missing on alignment. diff --git a/.github/PULL_REQUEST_TEMPLATE/web_app.md b/.github/PULL_REQUEST_TEMPLATE/web_app.md new file mode 100644 index 0000000..47399a5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/web_app.md @@ -0,0 +1,23 @@ +## Summary * +_What the user will notice in one or two sentences. Link to design or issue._ + +## Type of change +- [ ] Feature +- [ ] Bug fix +- [ ] Refactor / non-functional +- [ ] Documentation only +- [ ] Breaking change + +## Test plan * +_Golden path, key edge cases, and what was verified manually._ + +## Screenshots / Loom +_Embed images or a short Loom for UI changes. Skip for backend-only work._ + +## Risk & rollback +_Blast radius, feature flag, and how to revert if needed._ + +## Follow-ups +- [ ] (add follow-up tasks here) + +* Required sections — Moxie will flag if missing on alignment. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..57fb2dd --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## What changed * +_Summarize the change in plain language. Screenshots welcome for UI work._ + +## Why it matters * +_What problem does this solve, and for whom?_ + +## Pre-merge checks +- [ ] Tested locally +- [ ] Docs updated where needed +- [ ] No new console warnings + +## Follow-ups +- [ ] (add follow-up tasks here) + +* Required sections — Moxie will flag if missing on alignment.