Skip to content

Update acknowledgments and security - #6

Merged
wildsm merged 4 commits into
mainfrom
broaden-baseline-safe-defaults
Nov 10, 2026
Merged

wildsm merged 4 commits into
mainfrom
broaden-baseline-safe-defaults

Conversation

@wildsm

@wildsm wildsm commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

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:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works N/a
  • New and existing unit tests passed locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional Context

Codex and copilot assisted.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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

Comment thread .github/workflows/publish.yml Resolved
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>

@andrewfayres andrewfayres left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@wildsm
wildsm merged commit bf78ff0 into main Nov 10, 2026
7 checks passed
@wildsm
wildsm deleted the broaden-baseline-safe-defaults branch November 10, 2026 17:10
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.

4 participants