Northern_Lights/cherry-studio
1
0
Fork 0
mirror of https://github.com/CherryHQ/cherry-studio.git synced 2025-12-19 14:41:24 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

refactor: Update session tracking documentation for clarity and consistency

Browse Source
This commit is contained in:
Vaayne 2025-09-16 22:06:41 +08:00
parent e4d04f8346
commit 697f7d1946
1 changed files with 59 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
CLAUDE.md
View File

@ -14,45 +14,83 @@ This file provides guidance to AI coding assistants when working with code in th
1. **Code Search**: Use `ast-grep` for semantic code pattern searches when available. Fallback to `rg` (ripgrep) or `grep` for text-based searches. 1. **Code Search**: Use `ast-grep` for semantic code pattern searches when available. Fallback to `rg` (ripgrep) or `grep` for text-based searches.
2. **UI Framework**: Exclusively use **HeroUI** for all new UI components. The use of `antd` or `styled-components` is strictly **PROHIBITED**. 2. **UI Framework**: Exclusively use **HeroUI** for all new UI components. The use of `antd` or `styled-components` is strictly **PROHIBITED**.
3. **Quality Assurance**: **Always** run `yarn build:check` before finalizing your work or making any commits. This ensures code quality (linting, testing, and type checking). 3. **Quality Assurance**: **Always** run `yarn build:check` before finalizing your work or making any commits. This ensures code quality (linting, testing, and type checking).
4. **Session Documentation**: MUST Consistently maintain the session SDLC log file following the template structure outlined in the Session Tracking section. 4. **Session Tracking Documentation**: MUST Consistently maintain the session SDLC log file following the template structure outlined in the Session Tracking section.
5. **Centralized Logging**: Use the `loggerService` exclusively for all application logging (info, warn, error levels) with proper context. Do not use `console.log`. 5. **Centralized Logging**: Use the `loggerService` exclusively for all application logging (info, warn, error levels) with proper context. Do not use `console.log`.
6. **External Research**: Leverage `subagent` for gathering external information, including latest documentation, API references, news, or web-based research. This keeps the main conversation focused on the task at hand. 6. **External Research**: Leverage `subagent` for gathering external information, including latest documentation, API references, news, or web-based research. This keeps the main conversation focused on the task at hand.
## Session Tracking ## Session Tracking Protocol
ALWAYS maintain a session log in `.sessions/YYYY-MM-DD-HH-MM-SS-<feature>.md`. This is critical for tracking progress and decisions: Purpose: keep a living SDLC record so any coding agent can pause or resume work without losing momentum.
### When to Log
- Start a new file when kicking off a feature or major task branch.
- Append to the existing file whenever you switch focus, finish a task, encounter a blocker, or hand over.
- If you resume someone else's session, add a new patch log entry summarizing what you picked up and what remains.
### File Naming
- `.sessions/YYYYMMDD-<feature>.md`
- Example: `.sessions/20250916-agent-onboarding.md`
### Template
```md ```md
# <feature> — SDLC Session (<YYYY-MM-DD HH:MM>) # <feature> — SDLC Session (<YYYY-MM-DD>)
## Session Metadata
- Participants:
- Repo state / branch:
- Related tickets / docs:
- Links to prior sessions:
## Design Brief ## Design Brief
- Problem & goals: - Problem & goals:
- Non-goals/scope: - Non-goals / scope:
- Constraints & risks: - Constraints & risks:
- Acceptance criteria: - Acceptance criteria:
## Solution Design ## Solution Plan
- Architecture/flow: - Architecture / flow:
- Key interfaces: - Key interfaces or modules:
- Data model: - Data considerations:
- Test strategy: - Test strategy:
## Work Plan ## Work Plan
| ID | Task | Owner | Depends | Est | Status | | ID | Task | Owner | Depends | Est | Status | Notes |
| --- | ---- | ----- | ------- | --- | ------ | | --- | ---- | ----- | ------- | --- | ------ | ----- |
| T1 | | | | | TODO | | T1 | | | | | TODO | |
## Patch Log _Status values: TODO, IN PROGRESS, BLOCKED, DONE. Update estimates as work evolves._
### <HH:MM>
- Summary: ## Execution Log
- Files: ### <YYYY-MM-DD HH:MM>
- Tests/Commands: - Activity summary (what changed, decisions made)
- Next: - Artifacts (PRs, commits, file paths, specs)
- Tests / Commands run:
- Issues / Risks:
- Next focus before handoff:
_Append a new timestamped block for each meaningful work segment._
## Handoff Checklist
- [ ] Remaining work captured in Work Plan
- [ ] Blockers / questions called out
- [ ] Links to diffs / PRs / relevant artifacts
- [ ] Next session entry point documented
## Validation ## Validation
- [ ] Criteria met - [ ] Acceptance criteria met
- [ ] build:check passes - [ ] `yarn build:check` passes
- [ ] Tests green - [ ] Tests required by strategy green
- [ ] Docs / tickets updated (if applicable)
```
### Usage Example
```
### 2025-09-16 18:40
- Activity: Finished wiring HeroUI settings panel skeleton; left TODO for data bindings.
- Artifacts: src/renderer/.../SettingsPanel.tsx, PR #1234 (draft).
- Tests / Commands: yarn lint
- Issues / Risks: Waiting on API schema (#456).
- Next focus: Bind `updateSettings` once API lands; run yarn build:check before flip to PR.
``` ```