docs: add AI working agreement and project context files - #1
Merged
Merged
Conversation
Adds a CLAUDE.md working agreement so each assistant session starts from a short project brief instead of re-scanning the repo. It also requires every task to leave the changelog, TODO list and decision log up to date. The context files were written after one pass over the repo: CONTEXT.md holds the directory map, commands, conventions and known gotchas; ARCHITECTURE.md covers the main/preload/renderer split, the IPC surface, data flow and env var names; TODO.md and CHANGELOG.md start the running logs. The decisions dated 2026-09-29 and the changelog history were reconstructed from the code and commits, not from design notes, and DECISIONS.md says so. They may need corrections from the author.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a CLAUDE.md working agreement so each assistant session starts from a short project brief instead of re-scanning the repo. It also requires every task to leave the changelog, TODO list and decision log up to date.
The context files were written after one pass over the repo: CONTEXT.md holds the directory map, commands, conventions and known gotchas; ARCHITECTURE.md covers the main/preload/renderer split, the IPC surface, data flow and env var names; TODO.md and CHANGELOG.md start the running logs.
The decisions dated 2026-09-29 and the changelog history were reconstructed from the code and commits, not from design notes, and DECISIONS.md says so. They may need corrections from the author.