obsidian-plugin/firstsun-dev_git-files-sync
1
0
Fork 0
mirror of https://github.com/firstsun-dev/git-files-sync.git synced 2026-07-22 17:20:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: symlink CLAUDE.md to AGENTS.md

Browse source
This commit is contained in:
ClaudiaFang 2026-07-18 17:44:25 +00:00
parent 38b2610b30
commit a90fb3c62c
2 changed files with 10 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
AGENTS.md
View file

@ -1,55 +1,12 @@
# Project Agent Design & Hierarchy (Synchronized with Skills)
# CLAUDE.md
## Startup Workflow
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Before writing code:
- Read `feature_list.json` (active/next-up work — GitHub Issues on `firstsun-dev/git-files-sync`, Project #6, is the real source of truth; re-sync stale entries) and `progress.md` (what's currently open).
- Read `session-handoff.md` for the previous session's exact stopping point.
- Run `./init.sh` to confirm a clean, green baseline before editing.
## Agent Workflow
## Definition of Done
A feature is done only when all of the following hold, with evidence recorded (command + result) in `progress.md`:
- `npx eslint .` — 0 errors
- `npm run build` — passes (tsc + Obsidian 1.11.0 compat typecheck + esbuild)
- `npx vitest run` — passes
- Manual verification in Obsidian, when the change has a runtime UI surface
## Stay in Scope
- One feature at a time: pick a single `feature_list.json` entry and finish it (with recorded evidence) before starting the next.
- Don't expand scope mid-task — file a new GitHub issue via the `firstsun-pm` skill instead of quietly bundling unrelated work.
## End of Session
Before ending a session:
- Overwrite `session-handoff.md` (don't append) with the new stopping point so the repo stays restartable.
- Move finished items from `progress.md` into `archive/YYYY-MM.md` (current month) — next steps in `progress.md` should read as a short list, not a changelog.
## Agent Tiers
### 1. High-Tier (Red/Orange Group)
- **Sonnet 4.6 (Primary)**: Orchestrator for complex planning and architecture.
- **Opus (Architect)**: Deep research and large-scale refactoring.
### 2. Low-Tier (Blue/Green/Cyan Group)
- **Haiku (Specialized)**: Fast, token-efficient model for TDD, linting, and CI/CD monitoring. **REQUIRED**: All verification tasks MUST be offloaded to Haiku to save tokens.
- **Subagents**: Isolated tasks for context protection.
## Core Workflows (Mandatory Skills Integration)
### 1. TDD & Linting (Skill: `obsidian-development`)
- **Rule**: Write Vitest tests BEFORE implementation.
- **Execution**: Offload `npx vitest run` and `npm run lint` to Haiku.
- **Report Format**: `Success: N items, Failure: X items` (including error logs on failure).
### 2. Marketplace Readiness (Skill: `obsidian-marketplace-check`)
- **Rule**: Verify compliance before any release candidate.
- **Checks**: `manifest.json` parity, `isDesktopOnly` logic, and `onunload` cleanup.
### 3. CI/CD Monitoring (Skill: `obsidian-development`)
- **Rule**: Post-push monitoring by Haiku in the background.
- **Failure Protocol**: Fetch and return specific error messages from the CI pipeline.
### 4. Git Integrity
- **Pre-commit**: Husky hook running `npm run lint && npm run build`.
- **Startup**: read `feature_list.json` (active/next-up work; GitHub Issues on `firstsun-dev/git-files-sync`, Project #6, is the actual source of truth — re-sync before trusting stale entries) and `progress.md` (what's open right now), then `session-handoff.md` for the previous session's exact stopping point.
- **Before editing**: run `./init.sh` (installs deps, then lint + test + build) to confirm you're starting from a green baseline.
- **Definition of done**: `npx eslint .` has 0 errors, `npm run build` passes (includes the Obsidian 1.11.0 compat typecheck), and `npx vitest run` passes, *and* evidence of that run is recorded (one line: command + result) in `progress.md` or the PR description — not just claimed.
- **Scope**: work one `feature_list.json` entry at a time; don't start the next until the current one's evidence is recorded.
- **End of session**: overwrite `session-handoff.md` with the new stopping point, move finished items from `progress.md` into `archive/YYYY-MM.md` (current month).
- Issue/PR conventions (Conventional Commits titles, Project #6 fields, English-only for this public plugin repo) are defined in the `firstsun-pm` skill, not duplicated here.

12
CLAUDE.md
View file

@ -1,12 +0,0 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Agent Workflow
- **Startup**: read `feature_list.json` (active/next-up work; GitHub Issues on `firstsun-dev/git-files-sync`, Project #6, is the actual source of truth — re-sync before trusting stale entries) and `progress.md` (what's open right now), then `session-handoff.md` for the previous session's exact stopping point.
- **Before editing**: run `./init.sh` (installs deps, then lint + test + build) to confirm you're starting from a green baseline.
- **Definition of done**: `npx eslint .` has 0 errors, `npm run build` passes (includes the Obsidian 1.11.0 compat typecheck), and `npx vitest run` passes, *and* evidence of that run is recorded (one line: command + result) in `progress.md` or the PR description — not just claimed.
- **Scope**: work one `feature_list.json` entry at a time; don't start the next until the current one's evidence is recorded.
- **End of session**: overwrite `session-handoff.md` with the new stopping point, move finished items from `progress.md` into `archive/YYYY-MM.md` (current month).
- Issue/PR conventions (Conventional Commits titles, Project #6 fields, English-only for this public plugin repo) are defined in the `firstsun-pm` skill, not duplicated here.

1
CLAUDE.md Symbolic link
View file

@ -0,0 +1 @@
AGENTS.md