Skip to content

Add a session-start progress-record protocol #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JE-Chen merged 1 commit into from
Jul 25, 2026
Merged

Add a session-start progress-record protocol #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,6 @@ dmypy.json
/.idea
/.claude/
/output

# Local, untracked Claude working-progress record (see CLAUDE.md)
/PROGRESS.md
10 changes: 10 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# CLAUDE.md - JEditor Project Guidelines

## Session Start: Check the Progress Record

At the start of every session, check for `PROGRESS.md` in the repo root (a local,
untracked working-progress record — it is in `.gitignore`).

- If it exists and lists outstanding items, read it first to resume in-progress work.
- Keep it updated as work progresses; items may span both the JEditor and PyBreeze repos (each item names its repo).
- **When every item is done, clear it** — reset the file to just its heading and usage note, leaving no stale tasks.
- If it does not exist and there is multi-step or cross-session work worth tracking, create it.

## Project Overview

JEditor is a Python-based code editor built with PySide6 (Qt), featuring syntax highlighting, code formatting, plugin system, Git integration, and LangChain-powered AI assistance.
Expand Down
Loading