From d8abe80ea7fdf17be5d8ee93da11ffda81ff36b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timo=20K=C3=B6the?= Date: Sat, 22 Aug 2026 14:27:52 +0200 Subject: [PATCH] docs: add project guidance docs This commit adds AGENTS.md and a CLAUDE.md wrapper to document the Swift package conventions, verification steps, and testing expectations for contributors. --- AGENTS.md | 23 +++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 24 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..d7936cf --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,23 @@ +# AGENTS.md + +## Project + +- This repository is a lightweight Swift package for local notification management. +- Keep changes focused, dependency-free where practical, and compatible with the platform versions declared in `Package.swift`. +- Follow the existing Swift style and preserve source compatibility unless a breaking change is explicitly requested. + +## Changes + +- Put library code in `Sources/NotificationManager` and tests in `Tests/NotificationManagerTests`. +- Add or update XCTest coverage for behavior changes. Use the notification-center abstraction instead of relying on real notification delivery. +- Update public documentation and `README.md` when changing the public API or user-facing behavior. + +## Verification + +Run before finishing: + +```sh +swift test +``` + +For platform-sensitive changes, also build the affected destination with the `NotificationManager` scheme and code signing disabled. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md