Skip to content
Merged
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
1 change: 1 addition & 0 deletions .github/assets/agenttrail-guard-demo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Thanks for contributing! Setup and checks are in CONTRIBUTING.md. -->

## What this changes

<!-- One or two sentences: what behavior changes, and why. Link the issue if there is one. -->

## How I checked it

<!-- The commands you ran, and the agents and versions you tried it with. -->

## Checklist

- [ ] `pnpm lint`, `pnpm spell`, `pnpm typecheck`, and `pnpm test` pass
- [ ] Behavior changes have regression tests
- [ ] The rebuilt hook bundle is included, if this change affects it
- [ ] Commit messages follow Conventional Commits
- [ ] No secrets, tokens, or private project details in code, tests, or screenshots
83 changes: 83 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [security@agenttrail.sh](mailto:security@agenttrail.sh). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
114 changes: 114 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<!-- cspell:words agenttrailhq hostnames -->

# Contributing to AgentTrail Guard

Thanks for helping make AI coding agents safer to run. Bug reports, rule ideas,
documentation fixes, and integration fixes are all welcome. You do not need to write code:
a small, reproducible example of an unexpected block or a missed action is one of the most
useful contributions.

By taking part, you agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md). To report a
security vulnerability, follow [SECURITY.md](SECURITY.md) instead of opening an issue.

## Where does my contribution go?

Code changes to Guard itself land here; the rules it enforces live in
[agenttrailhq/guardrails](https://github.com/agenttrailhq/guardrails). The README explains
[how the two fit together](README.md#guard-and-guardrails).

| You want to… | Where it goes |
| --- | --- |
| Report a bundled rule firing on a legitimate command (a false positive) | [Guardrails issues](https://github.com/agenttrailhq/guardrails/issues) |
| Report a dangerous command no rule catches | [Guardrails issues](https://github.com/agenttrailhq/guardrails/issues) |
| Contribute a rule, with matching and non-matching examples | [Guardrails](https://github.com/agenttrailhq/guardrails#contributing-a-rule) |
| Fix a hook, install, `status`, `scan`, or CLI problem | [Guard issues](https://github.com/agenttrailhq/guard/issues) and pull requests |
| Improve documentation | The repository the document lives in |

If you are not sure which repository fits, open a
[Guard issue](https://github.com/agenttrailhq/guard/issues) and describe what you saw.

## Reporting a bug or a false positive

Include:

- your Guard version (`agenttrail-guard --version`);
- your agent and its version;
- your operating system;
- the command or tool call involved;
- the guardrail id from `status`;
- what you expected to happen.

Share sanitized examples only: remove secrets, tokens, internal hostnames, and private
project details. `scan --review` shows you exactly what a report contains before you share
it.

## Trying a rule locally

To try a rule before proposing it, use `agenttrail-guard guardrails validate <file.json>`,
then `agenttrail-guard guardrails add <file.json>`. The rule format and what a contributed
rule needs are in the
[guardrails README](https://github.com/agenttrailhq/guardrails#contributing-a-rule).

## Development setup

Use the pnpm version pinned in `package.json`. CI runs on Node.js 22.

```sh
git clone https://github.com/agenttrailhq/guard.git
cd guard
pnpm install --frozen-lockfile
pnpm build
pnpm test
```

## Contribute with your coding agent

Using Claude Code, Cursor, or Codex CLI? From a fresh clone, paste this prompt into your agent
and fill in the last line of step 3:

```text
You are helping me contribute to AgentTrail Guard, the repository in this directory.
1. Read README.md and CONTRIBUTING.md before changing anything.
2. Run `pnpm install --frozen-lockfile`, `pnpm build`, and `pnpm test`, and tell me about
any failure before we start.
3. Help me make this change: <describe the bug or improvement>.
4. Add or update tests for any behavior change.
5. Run `pnpm lint`, `pnpm spell`, `pnpm typecheck`, and `pnpm test`. If the change affects
the hook bundle, run `pnpm build` and include plugin/scripts/guard-hook.mjs.
6. Suggest a Conventional Commit message. Do not push, publish, or add secrets.
```

With Guard installed, your agent's commands are checked while it works on Guard.

## Before you open a pull request

Run the checks used in CI:

```sh
pnpm lint
pnpm spell
pnpm typecheck
```

- **Commit messages:** use Conventional Commits, such as `docs: clarify installation` or
`fix: handle missing hook files`. CI checks commit messages on pull requests.
- **Tests:** add regression coverage for behavior changes.
- **The hook bundle:** it is committed because the plugin runs it directly. CI rebuilds it
and checks that it matches the committed copy, so include the rebuilt bundle when a code
change affects it.

## Find your way around

| Path | Contents |
| --- | --- |
| [src/commands/](src/commands/) | CLI commands: setup, status, scans, and guardrail management |
| [src/engine/](src/engine/) | Rule matching and policy evaluation |
| [src/core/](src/core/) | Agent payload mapping, configuration, logs, and report generation |
| [src/__tests__/](src/__tests__/) | Unit, integration, privacy, and runtime checks |
| [plugin/](plugin/) | Claude Code plugin and bundled scripts |

## License

AgentTrail Guard is licensed under the [Apache License 2.0](LICENSE). Under section 5 of
that license, a contribution you submit for inclusion is provided under the same terms,
unless you state otherwise.
Loading
Loading