Skip to content

docs: issue templates, PR templates, and CONTRIBUTING.md - #68

Merged
simonteague6 merged 2 commits into
mainfrom
docs/contribution-workflow
Sep 8, 2026
Merged

simonteague6 merged 2 commits into
mainfrom
docs/contribution-workflow

Conversation

@simonteague6

@simonteague6 simonteague6 commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This PR introduces 3 issue templates, a PR template, and updates the CONTRIBUTING.md. It also disables blank issue templates.

Why

It provides a standard way of writing issues, in a very simple and readable format. This enables everyone to create issues, because it makes it much simpler and easier. It also forces AI to use the same format, making issue creation with AI reliable. PR templates also help document what the author actually contributed, giving them a chance to explain what they did, like I am doing here.

Related issue

Closes #67

What changed

  • created bug issue template
  • created feature issue template
  • created chore issue template
  • created PR template
  • rewrote CONTRIBUTING.md entirely

How it was tested

just check result

  • just check passes locally (matches CI)

Data or schema impact

N/A (no data/schema impact)

Deployment or rollback considerations

N/A


Author checklist

  • Linked to one issue with a closing keyword (Closes #…, Fixes #…, or Resolves #…)
  • PR title uses Conventional Commit style (e.g. feat:, fix:, docs:) so the squashed commit is clear
  • Related tests updated and passing
  • just check passes and CI is green
  • Screenshots/recordings included for UI changes
  • just validate-data run for graph-data changes
  • I understand and can explain every change in this PR (including AI-written code)

@simonteague6 simonteague6 changed the title Docs/contribution workflow docs: issue templates, PR templates, and CONTRIBUTING.md Sep 8, 2026
@simonteague6
simonteague6 merged commit 625551e into main Sep 8, 2026
1 check passed
@simonteague6
simonteague6 deleted the docs/contribution-workflow branch September 8, 2026 05:08
@SamuelSaylor

Copy link
Copy Markdown

beautiful

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.

[Task]: Standardize issue forms, PR template, and contribution workflow

2 participants