Skip to content

Add pull request template - #8

Open
KardelRuveyda wants to merge 1 commit into
erturklab:mainfrom
KardelRuveyda:add-pr-template
Open

Add pull request template#8
KardelRuveyda wants to merge 1 commit into
erturklab:mainfrom
KardelRuveyda:add-pr-template

Conversation

@KardelRuveyda

Copy link
Copy Markdown

What

Adds .github/pull_request_template.md. Once merged, every new pull request opened against this repo will be pre-populated with a short, opinionated checklist.

Why

  • Helps contributors structure their PRs so maintainers can review faster.
  • Surfaces a few things that are easy to forget but painful to clean up afterwards: large binaries, secrets, README updates after a behavioural change.
  • Quietly directs contributors to CODE_OF_CONDUCT.md and SECURITY.md at the moment they are most relevant.

What's in the template

  • Summary — one or two sentences.
  • Type of change — checkbox list (bug fix, feature, breaking, docs, refactor, CI/housekeeping, other).
  • Related issuesCloses #… style links.
  • How has this been tested? — encourages mentioning runs on example_data/.
  • Checklist — Code of Conduct, single topic, README update, no binaries, no secrets, security path.
  • Additional notes — escape hatch for screenshots / benchmarks.

Notes for the maintainer

  • Docs/config only; no code touched.
  • Every section is optional — the template tells contributors they can delete sections that don't apply, so it stays lightweight.
  • This PR itself was opened before the template existed in main, so it does not show the new checklist (GitHub only applies templates that are already on the base branch).

Adds .github/pull_request_template.md so every new PR opens with a short, opinionated checklist (summary, change type, related issues, testing notes, no-binaries / no-secrets reminders). Links to the existing CODE_OF_CONDUCT.md and SECURITY.md so contributors discover them at the right moment.
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.

1 participant