chore: document api decision - #28
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation and architectural decision records (ADRs) to the OK-FP TypeScript library, establishing written context for AI coding agents and a record of the object-with-methods API design decision.
Changes:
- Adds
CLAUDE.mdandAGENTS.mdas identical agent-context files covering project structure, tech stack, conventions, and guidelines. - Adds
decisions/adr-template.md(a standard ADR template) anddecisions/0001-use-object-with-methods-api.md(documenting the choice to use method chaining over free functions + pipe). - Updates
.gitignoreto ignore the.claudedirectory used by the Claude agent.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
CLAUDE.md |
Agent context file for Claude; content is accurate and matches the actual codebase structure, but is byte-for-byte identical to AGENTS.md |
AGENTS.md |
Agent context file for OpenAI Codex/Agents; identical to CLAUDE.md, creating a maintenance duplication risk |
decisions/adr-template.md |
Standard ADR template file for future architectural decisions |
decisions/0001-use-object-with-methods-api.md |
ADR documenting the object-with-methods API style decision |
.gitignore |
Adds .claude directory to ignored paths |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
CLAUDE.mdandAGENTS.mdto the project