Skip to content

docs(contributing): add testing requirements for OSSF compliance#254

Merged
WilliamBerryiii merged 3 commits intomainfrom
docs/ossf-test-policy
Jan 24, 2026
Merged

docs(contributing): add testing requirements for OSSF compliance#254
WilliamBerryiii merged 3 commits intomainfrom
docs/ossf-test-policy

Conversation

@WilliamBerryiii
Copy link
Copy Markdown
Member

@WilliamBerryiii WilliamBerryiii commented Jan 23, 2026

Description

Adds testing requirements documentation to CONTRIBUTING.md and updates the PR template to meet OSSF Silver badge criteria test_policy_mandated and tests_documented_added.

Related Issue(s)

Fixes #241
Fixes #242

Changes

CONTRIBUTING.md:

  • Fix TOC indentation (Style Guides and Testing Requirements are now top-level sections)
  • Correct coverage threshold from 70% to 18% informational baseline (matches CI)
  • Remove broken link to non-existent docs/architecture/testing.md
  • Add "When Tests Are Required" section with guidance on optional scenarios
  • Add minimal Pester test example

PR Template:

  • Add "Tests added for new functionality" checklist item

Type of Change

  • Documentation update

Testing

Documentation-only change. Validated with:

  • npm run lint:md
  • npm run spell-check

Checklist

Required Checks

  • Documentation is updated
  • Files follow existing naming conventions
  • Changes are backwards compatible

Security Considerations

  • This PR does not contain any sensitive or NDA information

- add formal test policy requiring tests for new functionality
- document test location conventions and Pester framework
- add npm run test:ps command for local test execution
- reference existing testing architecture documentation

📋 - Generated by Copilot
@WilliamBerryiii WilliamBerryiii requested a review from a team as a code owner January 23, 2026 05:00
Copilot AI review requested due to automatic review settings January 23, 2026 05:00
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 23, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 28.83%. Comparing base (0e4b02f) to head (ecb3eb7).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #254      +/-   ##
==========================================
+ Coverage   28.80%   28.83%   +0.03%     
==========================================
  Files          14       14              
  Lines        2736     2736              
==========================================
+ Hits          788      789       +1     
+ Misses       1948     1947       -1     
Flag Coverage Δ
pester 28.83% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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 a “Testing Requirements” section to CONTRIBUTING.md to clarify expectations for PowerShell test creation and local/CI test execution.

Changes:

  • Adds a new “Testing Requirements” section covering policy, conventions, and local test execution (npm run test:ps).
  • Updates the Table of Contents to include the new section and fixes an existing TOC indentation issue.

@WilliamBerryiii WilliamBerryiii changed the title docs(docs): add testing requirements section to CONTRIBUTING.md docs(contributing): add testing requirements for OSSF compliance Jan 23, 2026
@WilliamBerryiii WilliamBerryiii added documentation Improvements or additions to documentation ossf-compliance OpenSSF security compliance labels Jan 23, 2026
- fix TOC indentation (Style Guides and Testing Requirements are top-level)
- correct coverage threshold from 70% to 18% informational baseline
- remove broken link to non-existent testing.md
- add guidance on when tests are optional (docs/config changes exempt)
- add minimal Pester test example
- add test checklist item to PR template

Fixes #241
Fixes #242
Copilot AI review requested due to automatic review settings January 23, 2026 05:20
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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@WilliamBerryiii WilliamBerryiii merged commit 4db1a18 into main Jan 24, 2026
16 checks passed
@WilliamBerryiii WilliamBerryiii deleted the docs/ossf-test-policy branch January 24, 2026 00:21
WilliamBerryiii pushed a commit that referenced this pull request Jan 28, 2026
🤖 I have created a release *beep* *boop*
---


##
[2.0.0](hve-core-v1.1.0...hve-core-v2.0.0)
(2026-01-28)


### ⚠ BREAKING CHANGES

* **agents:** add Task Reviewer and expand RPI to 4-phase workflow
([#277](#277))

### ✨ Features

* **agents:** add hve-core-installer agent to extension package
([#297](#297))
([c0e48c6](c0e48c6))
* **agents:** add Task Reviewer and expand RPI to 4-phase workflow
([#277](#277))
([ae76cab](ae76cab))
* **build:** add code coverage reporting to Pester workflow
([#230](#230))
([a34822a](a34822a))
* **docs:** add GOVERNANCE.md for OSSF Silver Badge compliance
([#235](#235))
([b0e752c](b0e752c))
* **docs:** add ROADMAP.md for OSSF Silver badge compliance
([#238](#238))
([4a41c16](4a41c16))
* **mcp:** add MCP server configuration guidance and installer
enhancements ([#225](#225))
([0bce418](0bce418))
* **scripts:** add YAML linting with actionlint
([#234](#234))
([d9301f9](d9301f9))
* **security:** add OpenSSF Scorecard workflow and badge
([#271](#271))
([7c6d788](7c6d788))
* **skills:** add video-to-gif conversion skill with FFmpeg two-pass
optimization ([#247](#247))
([8d65c42](8d65c42))
* **tests:** add Pester tests for LintingHelpers and
Validate-MarkdownFrontmatter
([#197](#197),
[#198](#198))
([#205](#205))
([51ae563](51ae563))


### 🐛 Bug Fixes

* **build:** detect table formatting changes via git diff
([#261](#261))
([985eee0](985eee0))
* **build:** disable MD024 lint rule in CHANGELOG for release-please
([#220](#220))
([971df94](971df94))
* **build:** quote shell variables and group redirects in workflow files
([#299](#299))
([3372509](3372509))
* **build:** resolve scorecard badge and workflow security issues
([#301](#301))
([aeaed13](aeaed13))
* **extension:** remove frontmatter from README and exclude from
markdown linting
([#223](#223))
([4272529](4272529))
* **instructions:** quote applyTo glob pattern for YAML compatibility
([#216](#216))
([085199c](085199c))
* **scripts:** add FooterExcludePaths parameter to frontmatter
validation ([#334](#334))
([64db98d](64db98d))
* **scripts:** add GHSA word and logs/ exclusion to cspell config
([#214](#214))
([5c99b3f](5c99b3f))
* **scripts:** correct type assertions in Invoke-YamlLint.Tests.ps1
([#332](#332))
([af7050d](af7050d))
* **scripts:** eliminate false positives in dependency pinning npm
pattern ([#273](#273))
([ccbdfa3](ccbdfa3))
* **security:** add artifact attestation for signed releases
([#257](#257))
([c52d6e2](c52d6e2))
* standardize markdown footers and complete frontmatter
([#217](#217))
([b4e7556](b4e7556))


### 📚 Documentation

* add OpenSSF Best Practices Passing badge to README
([#239](#239))
([91bc529](91bc529))
* **architecture:** add architecture documentation and value proposition
([#252](#252))
([0e4b02f](0e4b02f))
* **contributing:** add testing requirements for OSSF compliance
([#254](#254))
([4db1a18](4db1a18))
* **docs:** add enterprise status badges to README header
([#270](#270))
([ccb68a4](ccb68a4))
* **security:** add security assurance case and threat model for OSSF
Silver ([#259](#259))
([a390e26](a390e26))


### ♻️ Refactoring

* **application:** wrap execution with try blocks, ensure proper …
([#296](#296))
([35c4417](35c4417))
* **scripts:** extract frontmatter validation to testable module
([#293](#293))
([4e8707e](4e8707e))
* **scripts:** extract pure functions for Pester testability
([#221](#221))
([d40e742](d40e742))


### 🔧 Maintenance

* **deps-dev:** bump cspell from 9.4.0 to 9.6.0 in the npm-dependencies
group ([#208](#208))
([855914b](855914b))
* **deps-dev:** bump cspell from 9.6.0 to 9.6.1 in the npm-dependencies
group ([#294](#294))
([1e45ad6](1e45ad6))
* **deps:** bump actions/setup-node from 6.1.0 to 6.2.0 in the
github-actions group
([#209](#209))
([c4c69e2](c4c69e2))
* **deps:** bump the github-actions group with 4 updates
([#295](#295))
([d8337b8](d8337b8))
* remove step-security/harden-runner from workflows
([#246](#246))
([c5708d8](c5708d8))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ossf-compliance OpenSSF security compliance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document test expectations for contributors (OSSF Silver badge compliance) Add formal test policy to CONTRIBUTING.md for OSSF Silver badge compliance

4 participants