sixfold-space/madtea
sixfold-space/madtea
SHA256
2
0
Fork 0
Code Issues 217 Pull requests Projects Releases 13 Packages Wiki Activity Actions 1

docs: require tests for new or changed behavior in CONTRIBUTING.md #862

Merged
hexajon merged 1 commit from issue-502-contributing-tests-required into main 2026-10-21 15:48:42 +00:00
Conversation 0 Commits 1 Files changed 1 +1
hexajon commented 2026-10-21 15:48:38 +00:00
Owner
Copy link

Summary

What was wrong

CONTRIBUTING.md did not say that new or changed behavior needs tests. The Testing section bans t.Skip() and //nolint. The Pull Request Guidelines require a green gate. No line asked for tests on new behavior. This is also the open item for the OpenSSF Best Practices criterion tests_documented_added.

What changed

I added one line to the "Pull Request Guidelines" list in CONTRIBUTING.md. It says that new or changed behavior comes with tests in the automated suite (go test ./...). It also says that a fix adds a test that fails without the fix.

No code changed. The diff is one added line in one file.

Tests

This is a docs-only change, so it adds no tests.

Refs #502

./scripts/gate.sh passes on this commit.

Closes #502

## Summary ## What was wrong `CONTRIBUTING.md` did not say that new or changed behavior needs tests. The Testing section bans `t.Skip()` and `//nolint`. The Pull Request Guidelines require a green gate. No line asked for tests on new behavior. This is also the open item for the OpenSSF Best Practices criterion `tests_documented_added`. ## What changed I added one line to the "Pull Request Guidelines" list in `CONTRIBUTING.md`. It says that new or changed behavior comes with tests in the automated suite (`go test ./...`). It also says that a fix adds a test that fails without the fix. No code changed. The diff is one added line in one file. ## Tests This is a docs-only change, so it adds no tests. Refs #502 `./scripts/gate.sh` passes on this commit. Closes #502
docs: require tests for new or changed behavior in CONTRIBUTING.md
All checks were successful
drift / govulncheck (pull_request) Has been skipped
Details
drift / forgejo-smoke (pull_request) Has been skipped
Details
drift / surface-diff (pull_request) Successful in 33s
Details
drift / govulncheck (push) Has been skipped
Details
drift / surface-diff (push) Successful in -43s
Details
drift / forgejo-smoke (push) Has been skipped
Details
ci / gate (push) Successful in 23m35s
Details
ci / gate (pull_request) Successful in 37m4s
Details
a82970ea72
 
Refs #502
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
breaking
Breaking change - flag for release notes

  
bug
Something is not working

  
documentation
Documentation only

  
enhancement
New feature

  
epic
Tracking epic with dependency children

  
good first issue
Interested in contributing? Get started here.

  
help wanted
Maintainer would welcome outside help

  
refactoring
Code restructuring without behavior changes

  
resolution/duplicate
Closed as duplicate of another issue

  
resolution/invalid
Closed as invalid or not reproducible

  
resolution/wontfix
Closed as won't fix

  
security
Security issue or hardening

  
severity/critical
Security severity: critical

  
severity/high
Security severity: high

  
severity/low
Security severity: low

  
severity/medium
Security severity: medium

  
status/abandoned
Someone started, then walked away - up for grabs

  
status/blocked
Blocked by another issue or an external dependency

  
status/needs-decision
Waiting on a maintainer decision; workable once decided

  
status/needs-info
Waiting on reporter / more information before work can start

  
status/needs-verification
Done except verification in a live interactive session

  
testing
Test suite / CI infrastructure work

  
upstream
Related to an upstream repository, already reported there

No labels
breaking
bug
documentation
enhancement
epic
good first issue
help wanted
refactoring
resolution/duplicate
resolution/invalid
resolution/wontfix
security
severity/critical
severity/high
severity/low
severity/medium
status/abandoned
status/blocked
status/needs-decision
status/needs-info
status/needs-verification
testing
upstream
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
sixfold-space/madtea!862
No description provided.