Skip to content

Add contributor docs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
msawczynk wants to merge 2 commits into
base: Perms
Choose a base branch
from
Open

Add contributor docs #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40f8bcb
Expand testing instructions
msawczynk Jul 20, 2025
d5f2d5a
Merge branch 'Perms' into kbpqs9-codex/create-comprehensive-agent.md-…
msawczynk Jul 20, 2025
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
10 changes: 9 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,16 @@ This file provides guidance for AI agents contributing to this repository.
```
Some tests require configuration files (for example `tests/config.json`) and may fail if those files or external services are unavailable.


4. To execute integration ("live") tests, run `pytest -m integration`. These tests interact with real Keeper accounts defined in the `tests/` configuration files and modify Vault records.
After they complete, sign in to the Keeper Vault used for testing and verify the expected changes (such as new or deleted records and folders).
Document any observations or issues in the `codex` directory so future contributors can review the results.


## Documentation Notes

Repository documentation references the [official Keeper Commander documentation](https://docs.keeper.io/secrets-manager/commander-cli/overview). Review that site for detailed usage instructions.

Additional documentation and notes are stored in the `codex` directory.

All additional documentation, test results and notes should be stored in the `codex` directory so they remain versioned with the project.

7 changes: 7 additions & 0 deletions codex/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,11 @@ Follow these steps to run the project tests.
pytest -q
```

4. Run integration tests (these modify a live Keeper account) with:
```bash
pytest -m integration
```
Check the Keeper Vault used for testing to confirm records and folders were created or removed as expected.


Tests may require additional configuration files found under `tests/`. Some integration tests rely on external Keeper accounts and will fail without proper credentials.