Skip to content

feat: added agents settings #538

Merged
jot2re merged 21 commits intomainfrom
tore/feat/agents
Apr 24, 2026
Merged

feat: added agents settings #538
jot2re merged 21 commits intomainfrom
tore/feat/agents

Conversation

@jot2re
Copy link
Copy Markdown
Collaborator

@jot2re jot2re commented Apr 21, 2026

Description of changes

Added basic context for AIs along with Claude specific configuration information to enhance efficiency and security.

AGENTS.md is hand written and reviewed by Claude whereas ARCHITECTURE.md is written by Claude after reading the code and documentation.

Issue ticket number and link

This closes https://github.com/zama-ai/kms-internal/issues/2971

PR Checklist

I attest that all checked items are satisfied. Any deviation is clearly justified above.

  • Title follows conventional commits (e.g. chore: ...).
  • Tests added for every new pub item and test coverage has not decreased.
  • Public APIs and non-obvious logic documented; unfinished work marked as TODO(#issue).
  • unwrap/expect/panic only in tests or for invariant bugs (documented if present).
  • No dependency version changes OR (if changed) only minimal required fixes.
  • No architectural protocol changes OR linked spec PR/issue provided.
  • No breaking deployment config changes OR devops label + infra notified + infra-team reviewer assigned.
  • No breaking gRPC / serialized data changes OR commit marked with ! and affected teams notified.
  • No modifications to existing versionized structs OR backward compatibility tests updated.
  • No critical business logic / crypto changes OR ≥2 reviewers assigned.
  • No new sensitive data fields added OR Zeroize + ZeroizeOnDrop implemented.
  • No new public storage data OR data is verifiable (signature / digest).
  • No unsafe; if unavoidable: minimal, justified, documented, and test/fuzz covered.
  • Strongly typed boundaries: typed inputs validated at the edge; no untyped values or errors cross modules.
  • Self-review completed.

Dependency Update Questionnaire (only if deps changed or added)

Answer in the Cargo.toml next to the dependency (or here if updating):

  1. Ownership changes or suspicious concentration?
  2. Low popularity?
  3. Unusual version jump?
  4. Lacking documentation?
  5. Missing CI?
  6. No security / disclosure policy?
  7. Significant size increase?

More details and explanations for the checklist and dependency updates can be found in CONTRIBUTING.md

@cla-bot cla-bot Bot added the cla-signed The CLA has been signed. label Apr 21, 2026
@jot2re jot2re requested a review from Copilot April 21, 2026 10:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds repository guidance and configuration for AI coding agents (including Claude), plus an architecture overview document for the KMS repo.

Changes:

  • Added ARCHITECTURE.md describing system context, workspace layout, and key subsystems.
  • Added AGENTS.md defining expectations/rules for AI coding agents in this repo.
  • Added Claude agent config (.claude/settings.json) and adjusted .gitignore for local Claude settings.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.

File Description
ARCHITECTURE.md New architecture documentation for the KMS system and repo layout.
AGENTS.md New policy/guidelines for AI coding agents working in this repository.
.gitignore Updates ignore rules around Claude configuration files.
.claude/settings.json Adds shared Claude agent settings (sandbox + ignore/sensitive patterns).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread ARCHITECTURE.md Outdated
Comment thread ARCHITECTURE.md Outdated
Comment thread ARCHITECTURE.md Outdated
jot2re and others added 3 commits April 21, 2026 12:42
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jot2re jot2re marked this pull request as ready for review April 21, 2026 10:44
@jot2re jot2re requested a review from a team as a code owner April 21, 2026 10:44
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 21, 2026

Consolidated Tests Results 2026-04-23 - 13:39:57

Test Results

passed 18 passed

Details

tests 18 tests
clock not captured
tool junit-to-ctrf
build build-and-test arrow-right test-reporter link #1600
pull-request feat: added agents settings link #538

test-reporter: Run #1600

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Pending ⏳ Other ❓ Flaky 🍂 Duration ⏱️
18 18 0 0 0 0 0 not captured

🎉 All tests passed!

Tests

View All Tests
Test Name Status Flaky Duration
nightly_full_gen_tests_k8s_default_threshld_sequential_crs 33.0s
test_k8s_threshld_insecure 3m 15s
k8s_test_crs_uniqueness 33.0s
k8s_test_insecure_keygen_encrypt_and_public_decrypt 3m 20s
k8s_test_insecure_keygen_encrypt_multiple_types 3m 41s
k8s_test_keygen_and_crs 3m 13s
k8s_test_keygen_uniqueness 8m 59s
nightly_full_gen_tests_k8s_default_threshld_sequential_crs 32.8s
test_k8s_threshld_insecure 3m 15s
k8s_test_crs_uniqueness 32.9s
k8s_test_insecure_keygen_encrypt_and_public_decrypt 3m 20s
k8s_test_insecure_keygen_encrypt_multiple_types 3m 42s
k8s_test_keygen_and_crs 3m 16s
k8s_test_keygen_uniqueness 8m 57s
nightly_full_gen_tests_k8s_default_centralzd_sequential_crs 1.7s
test_k8s_centralzd_insecure 1m 2s
k8s_test_centralized_insecure 1m 3s
nightly_full_gen_tests_default_k8s_centralized_sequential_crs 1.7s

🍂 No flaky tests in this run.

Github Test Reporter by CTRF 💚

🔄 This comment has been updated

kc1212
kc1212 previously approved these changes Apr 21, 2026
Copy link
Copy Markdown
Contributor

@kc1212 kc1212 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok for me. but we'll only know how well it works if we try it, I guess. maybe someone else can have a look as well?

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread ARCHITECTURE.md Outdated
Comment thread .gitignore
Comment thread .claude/settings.json Outdated
Comment thread AGENTS.md Outdated
Comment thread CLAUDE.md Outdated
Comment thread AGENTS.md Outdated
@jot2re jot2re requested a review from kc1212 April 22, 2026 16:02
@jot2re jot2re requested a review from dd23 April 22, 2026 16:02
@dd23
Copy link
Copy Markdown
Member

dd23 commented Apr 23, 2026

As discussed, let's break this up into a very compact root AGENTS.md that points to more specialized .md files / skills for specific things like code review, error handling, architecture overview, etc.

Once we have this in place, we should evaluate how it works for us.
Specifically for Claude, we could do this with /insights.

Comment thread .claude/settings.json Outdated
Comment thread ai-docs/EDITING.md Outdated
Comment thread ai-docs/EDITING.md
Comment thread ai-docs/EDITING.md Outdated
Comment thread ai-docs/EDITING.md Outdated
Comment thread ai-docs/EDITING.md
Comment thread ai-docs/EDITING.md
Comment thread ai-docs/ARCHITECTURE.md Outdated
Comment thread ai-docs/ARCHITECTURE.md
Co-authored-by: Daniel Demmler <daniel.demmler@zama.ai>
@jot2re jot2re requested review from dd23 and dvdplm April 23, 2026 12:22
Copy link
Copy Markdown
Contributor

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, let's try it.

Copy link
Copy Markdown
Member

@dd23 dd23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think this is in good shape now. Let's give it a try.

@jot2re jot2re merged commit e2c049c into main Apr 24, 2026
64 of 65 checks passed
@jot2re jot2re deleted the tore/feat/agents branch April 24, 2026 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed The CLA has been signed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants