Add org-default PR template#7
Merged
Merged
Conversation
GitHub only honors org-default community health files (PR/issue templates) from a public `.github` repo, not from private/internal `.github-*` repos: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file Empirically: until this lands, `pullRequestTemplates` returns `[]` for every trufflesecurity repo without a local template, so neither the GitHub web "New pull request" UI nor `gh pr create` populates a template body. Adding the template here makes it inherit into all org repos that lack a local override (web UI for everyone; `gh pr create` since v2.5 via cli/cli#5097, which queries the GraphQL `pullRequestTemplates` field). Content matches what previously lived in `trufflesecurity/.github-private` verbatim, with the example file path genericized from `api/pkg/services/jobs.go` to `path/to/file.go` since this file is now publicly visible. Followups (separate PR): - delete the orphan template from `trufflesecurity/.github-private` (it has never propagated and only causes confusion) - update the `.github-private` README to point at this new home and explain the public-`.github`-only inheritance rule Made-with: Cursor
dustin-decker
approved these changes
Apr 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
.github/PULL_REQUEST_TEMPLATE.mdso the org's PR template actually inherits into consumer repos.Why this is needed. GitHub only honors org-default community health files (PR/issue templates) from a public
.githubrepo, not from private/internal.github-*repos (docs). The template currently lives intrufflesecurity/.github-private, which means it has never propagated. Empirically, before this PR:After merge, every org repo without a local
PULL_REQUEST_TEMPLATE.mdwill inherit this one, in both:gh pr create(since v2.5, via cli/cli#5097, which queries the GraphQLpullRequestTemplatesfield — that field returns inherited org-default templates).Content. Verbatim copy of the template from
trufflesecurity/.github-private/.github/PULL_REQUEST_TEMPLATE.md, with one tweak: the example path inKey files to focus onwas genericized fromapi/pkg/services/jobs.gotopath/to/file.gosince this file is now publicly visible.Review guidance
.github/PULL_REQUEST_TEMPLATE.mdTesting
trufflesecurity/.githubis public (visibility: public) so org-default inheritance applies.gh pr createqueries the GraphQLpullRequestTemplatesfield, which returns inherited org-default templates.[]), making this the actual fix.After merge, will verify by:
interservice-contracts) and confirming the template prefills, andgh api graphql -f query='{ repository(owner:"trufflesecurity", name:"thog") { pullRequestTemplates { filename body } } }'and confirming a non-empty result.Deployment notes
Two followup PRs (separate, in
trufflesecurity/.github-private):.github-private/.github/PULL_REQUEST_TEMPLATE.md(has never propagated; only causes confusion to read)..github-privateREADME to point at this new home and explain the public-.github-only inheritance rule.No rollback concerns — this is a single new file with no runtime side effects. If the template content needs revision, edit it here and the change propagates immediately to all consumer repos at next PR creation.
Note
Low Risk
Adds a GitHub PR template file only; no runtime code paths or production behavior are affected.
Overview
Adds
.github/PULL_REQUEST_TEMPLATE.mdto provide an org-default pull request template.The template standardizes sections for Summary, review guidance, testing, and deployment notes, with brief instructions to keep PRs consistent and reviewable.
Reviewed by Cursor Bugbot for commit 8844a5f. Bugbot is set up for automated code reviews on this repo. Configure here.