Repository navigation
docs(readme): refresh the README and add contributing, security and conduct guides - #7
Merged
Merged
Conversation
…onduct guides - README: reformatted for developers and search, with a quick start, a recording of Guard blocking a real database reset, linked packs and the guardrail library on agenttrail.sh. The rules, counts and behavior it describes are unchanged. - CONTRIBUTING.md, SECURITY.md and CODE_OF_CONDUCT.md, which GitHub shows as tabs next to the README, plus a pull request template. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README states the total and a per-pack count. This fails the build if a rule is added or removed without updating them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
samc621
approved these changes
Oct 6, 2026
|
🎉 This PR is included in version 0.2.2 🎉 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 does
blocking a real database reset, linked packs, and links to the guardrail library on
agenttrail.sh. The rules, counts and behavior it describes are unchanged.
README. Security reports go to security@agenttrail.sh. Also adds a pull request template.
__tests__/readme.test.ts: fails the build if a rule is added or removed without updatingthe README's total and per-pack counts.
Getting it onto npmjs.com
npm shows the README from the published package, so it needs a release. The docs commit is
docs(readme):, which releases a patch under the rule added in #6.maintoo. The order does not matter: semantic-release checks every commitsince
v0.2.1with the config onmainat the time, so 0.2.2 is published when the second ofthe two PRs merges.
squashed commit takes the title.
The recording renders on npm too, because npm rewrites relative image paths to
raw.githubusercontent.com/agenttrailhq/guardrails/HEAD/….Checked
Spelling, typecheck, Biome, all 311 tests (including the new README test) and commitlint pass
locally.
🤖 Generated with Claude Code