Skip to content

Add OpenSSF-facing repository hygiene documents#271

Open
SamErde wants to merge 2 commits intomainfrom
samerde/repo-audit-plan
Open

Add OpenSSF-facing repository hygiene documents#271
SamErde wants to merge 2 commits intomainfrom
samerde/repo-audit-plan

Conversation

@SamErde
Copy link
Copy Markdown
Collaborator

@SamErde SamErde commented May 6, 2026

Summary

Adds repository hygiene documents that make support, security reporting, and contribution review expectations easier to find:

  • SECURITY.md for private vulnerability reporting and sensitive AD CS data handling guidance
  • SUPPORT.md for usage questions, bug reports, and security report routing
  • .github/PULL_REQUEST_TEMPLATE.md for validation, security impact, documentation impact, and PowerShell compatibility notes
  • README and contributing links to the new guidance

Notes

An untracked local review note named BRANCH_PROTECTION_AND_RULESETS_REVIEW.md was created for owner discussion and intentionally left out of this PR.

Deferred

  • No Pester tests or code coverage changes
  • No Write-Host cleanup
  • No plural noun warning cleanup
  • No remediation or TLS behavior changes

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

Add security, support, and pull request guidance for contributors. Link the new guidance from the README and contribution docs so vulnerability reports and support requests have clear public entry points.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SamErde SamErde marked this pull request as ready for review May 6, 2026 09:22
Copilot AI review requested due to automatic review settings May 6, 2026 09:22
@SamErde SamErde marked this pull request as draft May 6, 2026 09:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds repository hygiene documentation to make vulnerability reporting, support routing, and PR expectations easier to find (supporting OpenSSF-facing best practices for discoverability).

Changes:

  • Adds SECURITY.md with private vulnerability reporting instructions and guidance on handling sensitive AD CS output.
  • Adds SUPPORT.md describing where to ask questions, how to file bugs, and how to route security reports.
  • Adds a GitHub PR template and links the new guidance from README.md and CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
SUPPORT.md New support guidance with links to docs, issue templates, and security routing.
SECURITY.md New security policy describing supported versions, reporting process, and safe handling of sensitive AD CS data.
README.md Adds a “Security and Support” section linking to the new policy and support docs.
CONTRIBUTING.md Adds “Security” and “Support” sections linking contributors to the new docs.
.github/PULL_REQUEST_TEMPLATE.md Adds a PR template prompting validation, security/doc impact, and compatibility notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Apply standard English grammar rule: compound modifiers before a noun
should be hyphenated. 'security related issues' -> 'security-related issues'.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SamErde SamErde marked this pull request as ready for review May 6, 2026 10:00
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.

2 participants