docs: add Quickstart, honest comparison, and community-standards files#8
Merged
Merged
Conversation
- README: add a 60-second Quickstart at the top so cloners reach a working setup without configuration choices - README: replace the comparison with a neutral table that acknowledges where Codecov, Coveralls, and 5monkeys/cobertura-action win, plus "pick X if" guidance for honest tool selection - README: rename existing "Quick Start" to "Common Patterns" so the 60-second version is unambiguously the entry point - Add SECURITY.md with private vulnerability reporting via GitHub Security Advisories, supported version policy (v2.x only), and consumer hardening recommendations - Add CODE_OF_CONDUCT.md adopting Contributor Covenant 2.1 by reference with local reporting and enforcement details - CONTRIBUTING.md: fix placeholder clone URL and link to CoC + SECURITY - README: add Security section and CoC reference next to Contributing Targets the GitHub community-standards profile (security policy + CoC) to unblock enterprise adoption gates and clears the way for an OpenSSF Best Practices badge later. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
0 lines changed 0 uncovered 0 files 📋 Full diff-cover reportDiff CoverageDiff: origin/main...HEAD, staged and unstaged changesNo lines with coverage information in this diff. |
Use [email protected] (personal) instead of the LAAM work email for the public reporting channels. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Merged
Affanmir
added a commit
that referenced
this pull request
Jun 23, 2026
Patch release rolling up the work merged since v2.1.0: - Fix Markdown table rendering in PR comments and the step summary (#13, fixes #11) - Document the Dev Container dev environment (#12) - Note the new Quickstart / honest-comparison docs (#8) Also bumps the long-stale pyproject version (1.0.0 -> 2.1.1) to match the release. Co-authored-by: Claude Opus 4.8 <[email protected]>
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
1 participant
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.
Summary
Three discovery- and trust-focused changes aimed at fixing the trial-to-adopt funnel (50 unique clones / ~2 actual installs over 14 days):
5monkeys/cobertura-action. Replaces the previous all-Yes table. Adds rows where competitors win (historical trends, org dashboards, format breadth) and a "Pick X if…" footer so users self-select honestly.SECURITY.md(private vuln reporting via GitHub Security Advisories, v2.x supported, consumer hardening notes) andCODE_OF_CONDUCT.md(Contributor Covenant 2.1 adopted by reference, with local reporting/enforcement details).CONTRIBUTING.mdplaceholder clone URL fixed and now references both.The community files mainly unblock enterprise adopters whose security/legal teams gate on the presence of a security policy, and prepare the project for an OpenSSF Best Practices badge later.
Why
Per the PM analysis, stars/forks are vanity for an Action — adoption is the metric. The funnel leak is at clone → install (~4%). A frictionless Quickstart and an honest comparison are the two highest-leverage README changes for that gap.
Things to confirm before merge
SECURITY.mdandCODE_OF_CONDUCT.mdis[email protected]— change if a different inbox is preferred for OSS contact.SECURITY.mdresolves to the report form.Test plan
#common-patternsresolves (Quickstart links to it).https://github.com/Affanmir/diff-cover-action/community— Community Standards score should jump (Security policy ✓ and Code of conduct ✓ added).🤖 Generated with Claude Code