Repository navigation
Add contributing guide and proposed OpenSSF Best Practices answers - #1165
Merged
Merged
Conversation
CONTRIBUTING.md documents the bug reporting process, contribution requirements and test policy the passing badge asks for. .bestpractices.json carries proposed answers and justifications that bestpractices.dev picks up when the project entry is edited. Claude-Session: https://claude.ai/code/session_01FM1Tvz8jDNmhot3etAateY
cdalar
enabled auto-merge (squash)
October 4, 2026 16:50
Codecov Reportβ
All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1165 +/- ##
=======================================
Coverage ? 36.93%
=======================================
Files ? 51
Lines ? 5656
Branches ? 0
=======================================
Hits ? 2089
Misses ? 3567
Partials ? 0 β View full report in Codecov by Harness. π New features to boost your workflow:
|
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.
The Best Practices badge entry is at 18% for the passing level: 53 criteria have been unanswered since February 2025. The form itself can only be saved by the project owner, so this PR prepares everything the repo can provide.
Changes
CONTRIBUTING.mdβ bug reporting process, how to submit a change, and the requirements for acceptable contributions, including the policy that new functionality and fixes come with tests. This backs thecontribution_requirements,report_process,test_policyandtests_documented_addedcriteria. The README's Contributing section links to it..bestpractices.jsonβ proposed status and justification for 49 passing-level criteria. bestpractices.dev reads this file and shows the values as proposals when the entry is edited; nothing is saved until the owner accepts them.After merging
Open https://www.bestpractices.dev/projects/10052/passing/edit, click Save (and continue) π€ to pull in the proposals, review them, and save. Also change the home page URL there from
http://docs.onctl.io(now a 404) tohttps://onctl.sh.Deliberately not proposed
These need the maintainer's own answer or a fix first:
know_secure_design,know_common_errorsβ a statement about the primary developer's own knowledge.release_notesβ releases carry GoReleaser's commit list; the criterion asks for a human-readable summary rather than a raw log.static_analysis_fixedβ CodeQL has one open high-severity alert (go/insecure-hostkeycallback).vulnerabilities_fixed_60_days,vulnerabilities_critical_fixedβ three Dependabot alerts on the docs site's npm lockfile are older than 60 days.test_mostis proposed as Unmet (coverage is about 37%); it is a SHOULD criterion, so it does not block the passing level.π€ Generated with Claude Code
https://claude.ai/code/session_01FM1Tvz8jDNmhot3etAateY