docs: add comprehensive repository and release process guidelines
Summary
- Add comprehensive repository and release process guidelines (AGENTS.md)
- Add detailed release process documentation (notes/release-process.md)
- Remove outdated documentation files (comprehensive-fix.md, query-docs.md)
Test plan
- [x] Documentation files follow proper markdown formatting
- [x] Guidelines are clear and actionable
- [x] Release process is well-documented
🤖 Generated with Claude Code
Summary by CodeRabbit
-
Documentation
- Added AGENTS.md with repository guidelines: project layout, build/test commands, coding style, testing practices, commit/PR conventions, and release guidance.
- Added release-process guide describing tag-driven workflows, publish steps, version stamping, and verification procedures.
- Removed outdated planning notes for a React Hooks refactor and deprecated notes on standardizing query return values.
- Consolidated docs to clarify current workflows and reduce confusion.
Walkthrough
Adds repository and release-process documentation files; removes two internal planning notes. No source code, API, or runtime behavior changes.
Changes
| Cohort / File(s) | Summary |
|---|---|
New documentationAGENTS.md, notes/release-process.md |
Added repository guidelines (project structure, commands, coding/testing/commit conventions) and a tag-driven release process with build/publish steps and artifact handling. |
Removed planning notesnotes/comprehensive-fix.md, notes/query-docs.md |
Deleted internal implementation and refactor planning documents for React Hooks and query-return standardization. |
Sequence Diagram(s)
sequenceDiagram
autonumber
actor Dev as Developer
participant GH as Git Tag (e.g., [email protected])
participant CI as GitHub Actions
participant Base as Base Job (install / lint / build / test)
participant Pub as Publish Job (per-workspace)
participant NPM as npm Registry
Dev->>GH: Push release tag
GH-->>CI: Trigger workflow by tag prefix
CI->>Base: Run install, lint, build, tests
Base-->>CI: Emit artifacts and dist/fp-version.txt (stamped from GITHUB_REF)
CI->>Pub: Determine environment from tag prefix
Pub->>Pub: Regenerate manifests, patch versions, rewrite workspace ranges
Pub->>Pub: Remove publish scripts, mirror artifacts to dist/npm
Pub->>NPM: Publish packages
NPM-->>Dev: Packages available
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title Check | ✅ Passed | The title succinctly and accurately reflects the core changes by specifying the addition of repository and release process guidelines, matching the pull request’s primary objective of enhancing documentation without extraneous detail or noise. |
| Docstring Coverage | ✅ Passed | No functions found in the changes. Docstring coverage check skipped. |
✨ Finishing touches
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
- [ ] Commit unit tests in branch
jchris/repository-guidelines
📜 Recent review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between ffcb65c6fc9fb39cd59a75d386852a45375c8597 and 3b53434fa248b5c292545c4276eed962aa0f7e87.
📒 Files selected for processing (1)
-
AGENTS.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- AGENTS.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: ci compile
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
this is from my codex cli onboarding