Skip to content
Merged
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions docs/explanation/extending-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Extending Events

This project uses factories and registries to make it easy to introduce new event types while keeping core classes stable.

## Factory and Registry Overview

- **Event factories** (e.g. [`EventFactory`](../../nostr-java-api/src/main/java/nostr/api/factory/EventFactory.java) and its implementations) centralize event creation so that callers don't have to handle boilerplate like setting the sender, tags, or content.
- **TagRegistry** maps tag codes to concrete implementations, allowing additional tag types to be resolved at runtime without modifying `BaseTag`.

## Adding a New Event Type

1. **Define the kind.** Add a constant to [`Kind`](../../nostr-java-base/src/main/java/nostr/base/Kind.java) or reserve a custom value.
2. **Implement the event.** Create a class under `nostr.event.impl` that extends `GenericEvent` or a more specific base class.
3. **Provide a factory.** Implement a factory extending `EventFactory` to encapsulate default tags and content for the new event.
4. **Register tags.** If the event introduces new tag codes, register their factory functions with [`TagRegistry`](../../nostr-java-event/src/main/java/nostr/event/tag/TagRegistry.java).
5. **Write tests.** Add unit and integration tests covering serialization, deserialization, and NIP compliance.
6. **Follow contributing guidelines.** Run `mvn -q verify` before committing, ensure events comply with Nostr NIPs, and document your changes.

## Testing & Contribution Requirements

- Run `mvn -q verify` from the repository root and ensure all checks pass.
- Include comprehensive tests for new functionality and remove unused imports.
- Summaries of changes and test results are expected in pull requests.

Refer to the repository's `AGENTS.md` for the full list of contribution expectations.
Copy link

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

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

The reference to AGENTS.md appears to be a non-standard filename for contribution guidelines. Consider verifying this filename exists or if it should be CONTRIBUTING.md which is the conventional name for contribution guidelines.

Suggested change
Refer to the repository's `AGENTS.md` for the full list of contribution expectations.
Refer to the repository's `CONTRIBUTING.md` for the full list of contribution expectations.

Copilot uses AI. Check for mistakes.