Repository navigation
Update acknowledgments and security - #6
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The release workflow can build and publish a same-named branch instead of the released commit because checkout uses an unqualified tag name rather than the release event’s commit SHA.
1 open issue
What changed in this PR
This PR updates BaseTemplate’s security and funding documentation, broadens its repository guidance beyond Python, and hardens CI and package publishing.
Changes:
- Add private security-reporting routes, sensitive-data handling guidance, and updated DOE acknowledgment and government rights language.
- Separate shared repository requirements from Python starter defaults and document adoption and administrator setup.
- Add documentation checks, pin workflow actions, enforce dependency locks, and make coverage reporting and publishing opt-in.
| File | Description |
|---|---|
SECURITY.md |
Adds reporting contacts, history checks, and operational security guidance. |
README.md |
Broadens repository requirements and updates funding and government rights statements. |
docs/index.md |
Adds security links and removes Discussions links. |
docs/getting_started.md |
Documents adoption, administrator controls, and workflow configuration. |
docs/faq.md |
Removes the Discussions contact option. |
CONTRIBUTING.md |
Adds safe reporting and artifact-appropriate validation guidance. |
CHANGELOG.md |
Records documentation, CI, and security changes. |
.gitignore |
Ignores additional environment files while preserving example templates. |
.github/workflows/publish.yml |
Adds opt-in release publishing with separate build and Trusted Publishing jobs. |
.github/workflows/ci.yml |
Adds documentation checks, action pins, locked dependencies, and opt-in coverage uploads. |
.github/pull_request_template.md |
Adds AI assistance disclosure and broader validation and security reminders. |
.github/ISSUE_TEMPLATE/bug_report.md |
Adds private-reporting guidance and broader runtime context fields. |
Review effort: Balanced
Change checkout reference to use the current commit SHA instead of the release tag. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
wildsm
marked this pull request as ready for review
November 9, 2026 20:39
This was referenced Nov 9, 2026
ajtritt
approved these changes
Nov 10, 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.

Description
This updates the security contact email, asks for additional history checks, hardens the CI and security process, adds a Govt disclaimer, and updates the funding acknowledgment.
Type of Change
Please mark the relevant option:
Checklist
I have added tests that prove my fix is effective or that my feature worksN/aAdditional Context