Skip to content

Add project guidance docs #11

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

Merged
timokoethe merged 1 commit into from
Aug 22, 2026
Merged

Add project guidance docs #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
Loading