Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ npm test
- `skills/agentguard/` — Claude Code skill definition (SKILL.md + reference docs)
- `hooks/` — Plugin hooks configuration for auto-guard
- `examples/` — Demo projects for testing
- `docs/i18n/` — Localized documentation and translated README files

## Making Changes

Expand All @@ -32,6 +33,13 @@ npm test
4. Run `npm run build && npm test` to verify
5. Submit a pull request

## Documentation Translations

- Keep the canonical source in English unless maintainers decide otherwise
- Store translated README files in `docs/i18n/`
- Use locale-based names such as `README.zh-Hans.md`, `README.zh-Hant.md`, and `README.ja.md`
- When updating translated files, preserve the same section order as the main `README.md`

## Adding Detection Rules

New scan rules go in `src/scanner/rules/`. Each rule needs:
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
[![CI](https://github.com/GoPlusSecurity/agentguard/actions/workflows/ci.yml/badge.svg)](https://github.com/GoPlusSecurity/agentguard/actions/workflows/ci.yml)
[![Agent Skills](https://img.shields.io/badge/Agent_Skills-compatible-purple.svg)](https://agentskills.io)

Languages: **English** | [简体中文](docs/i18n/README.zh-Hans.md) | [繁體中文](docs/i18n/README.zh-Hant.md) | [日本語](docs/i18n/README.ja.md)

## Why AgentGuard?

AI coding agents can execute any command, read any file, and install any skill — with zero security review. The risks are real:
Expand Down
Loading