Repository navigation
docs: refresh README and add community health files - #4
Merged
Merged
Conversation
Rewrite the README for first-time users: a quick start right after the intro, a recording of a real install, the 74 guardrails by pack, block/ask/warn behavior per agent, tuning and custom-rule examples with real CLI output, and links to the Guard and OS product pages. The detailed reference sections keep their technical content. Add CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1) and a pull request template, so GitHub shows the Contributing, Security and Code of conduct tabs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Point readers of "What Guard catches" to agenttrail.sh/guardrails, where every rule can be browsed and a command can be checked against the rules. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Use colons, semicolons, commas and parentheses instead. Wording is unchanged, and the real CLI output shown in the README keeps the em dashes the CLI prints. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
loveneeshdhir
requested review from
samc621
and removed request for
akarshtechsuite
October 2, 2026 19:44
samc621
approved these changes
Oct 2, 2026
samc621
left a comment
samc621
left a comment
Contributor
There was a problem hiding this comment.
@loveneeshdhir thanks, LGTM!
|
🎉 This PR is included in version 0.4.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
2 participants
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.
What this changes
A README rewrite for developers meeting Guard for the first time, plus the community files
GitHub uses to show the Contributing, Security and Code of conduct tabs.
README
install (
.github/assets/agenttrail-guard-demo.svg) and then Quick start./hooksapproval), plus short upgrade and uninstall steps that link to the full reference.
guardrails by pack with their default actions, how block/ask/warn behave per agent,
tuning and custom-rule examples (real CLI output), privacy at a glance, a Guard vs OS
comparison, troubleshooting, and an FAQ.
/agenttrail-guard,/agenttrail-os), the installguide, Security & Trust, and the
--force-resetcase study.status, rulemanagement, scan reports, crash reporting, runtime rules, files kept, and every agent's
limits) keep their technical content. Changes there are formatting, brand capitalization,
and one de-duplicated redaction paragraph; the heading "When a guardrail is wrong" is
now "Managing guardrails".
New files
CONTRIBUTING.md: where each report belongs (Guard vs Guardrails), build and teststeps, CI checks, a code map, and a copy-paste prompt for contributing with a coding agent.
SECURITY.md: private reporting to security@agenttrail.sh, and what is and is not inscope, based on Guard's documented guarantees.
CODE_OF_CONDUCT.md: Contributor Covenant 2.1, with security@agenttrail.sh as the contact..github/pull_request_template.md: a short checklist matching CI.None of the new files are in the npm package's
fileslist, so the published package isunchanged.
How I checked it
bundled
@agenttrail/guardrails@0.2.0catalog: 74 rules, 11 packs, 13 block, 50 ask,11 warn; every pack's example commands and the per-agent block/ask/warn behavior were
run through the real hook.
a real
npm install,init --agent claudeandstatus, run against a throwaway config.copy-claims,cli,plugin) pass, andpnpm spellandpnpm typecheckare clean. Locally on Windows the suite has pre-existing path andline-ending failures that are identical with and without this change; CI on Linux is
the real check.
Follow-ups outside this PR
("traces your agent's execution and automatically compiles repeat failures…"). It
should be updated to describe Guard, with the website set to
https://www.agenttrail.sh/agenttrail-guard.
🤖 Generated with Claude Code