Skip to content

Commit adebf29

Browse files
authored
Merge pull request #25 from 1Password/jill/add-contributing-md
Add CONTRIBUTING.md file
2 parents ff769c9 + 154c4fd commit adebf29

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to 1Password Agent Hooks
2+
3+
Thanks for your interest in contributing to the 1Password Agent Hooks project! 🙌 We appreciate your time and effort. Here are some guidelines to help you get started.
4+
5+
## Scope
6+
7+
This repository ships **1Password agent hooks** for supported IDEs/agents (e.g. Cursor, GitHub Copilot). Hooks run on agent events (such as before shell or tool use) and are installed via `install.sh` from the repo root. For user-facing install and config steps, see [README.md](README.md).
8+
9+
## Getting started
10+
11+
1. Fork and clone the repository.
12+
2. Install [Bats](https://github.com/bats-core/bats-core) (the test suite uses Bats).
13+
3. From the repo root, run the full test suite (see below).
14+
15+
## Running tests
16+
17+
Run all tests:
18+
19+
```bash
20+
bats -r tests/
21+
```
22+
23+
## Conventions
24+
25+
- New hooks: Put them in `hooks/<hook-name>/` with a README that covers behavior, which agent events to use, and known limits.
26+
- Shipping a hook: Update `install-client-config.json` (and confirm `install.sh` works. e.g ./`install.sh --agent cursor --target-dir /path/to/your/repo`).
27+
- Tests: Add Bats tests for changes or new additions.

0 commit comments

Comments
 (0)