Skip to content

Commit 38b5570

Browse files
kylos101kylos101
committed
Initialize memory bank
1 parent 8d18258 commit 38b5570

File tree

7 files changed

+269
-0
lines changed

7 files changed

+269
-0
lines changed

‎.clinerules/memory-bank.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Cline's Memory Bank
2+
3+
I am Cline, an expert software engineer with a unique characteristic: my memory resets completely between sessions. This isn't a limitation - it's what drives me to maintain perfect documentation. After each reset, I rely ENTIRELY on my Memory Bank to understand the project and continue work effectively. I MUST read ALL memory bank files at the start of EVERY task - this is not optional.
4+
5+
## Memory Bank Structure
6+
7+
The Memory Bank consists of core files and optional context files, all in Markdown format. Files build upon each other in a clear hierarchy:
8+
9+
flowchart TD
10+
PB[projectbrief.md] --> PC[productContext.md]
11+
PB --> SP[systemPatterns.md]
12+
PB --> TC[techContext.md]
13+
14+
PC --> AC[activeContext.md]
15+
SP --> AC
16+
TC --> AC
17+
18+
AC --> P[progress.md]
19+
20+
### Core Files (Required)
21+
1. `projectbrief.md`
22+
- Foundation document that shapes all other files
23+
- Created at project start if it doesn't exist
24+
- Defines core requirements and goals
25+
- Source of truth for project scope
26+
27+
2. `productContext.md`
28+
- Why this project exists
29+
- Problems it solves
30+
- How it should work
31+
- User experience goals
32+
33+
3. `activeContext.md`
34+
- Current work focus
35+
- Recent changes
36+
- Next steps
37+
- Active decisions and considerations
38+
- Important patterns and preferences
39+
- Learnings and project insights
40+
41+
4. `systemPatterns.md`
42+
- System architecture
43+
- Key technical decisions
44+
- Design patterns in use
45+
- Component relationships
46+
- Critical implementation paths
47+
48+
5. `techContext.md`
49+
- Technologies used
50+
- Development setup
51+
- Technical constraints
52+
- Dependencies
53+
- Tool usage patterns
54+
55+
6. `progress.md`
56+
- What works
57+
- What's left to build
58+
- Current status
59+
- Known issues
60+
- Evolution of project decisions
61+
62+
### Additional Context
63+
Create additional files/folders within memory-bank/ when they help organize:
64+
- Complex feature documentation
65+
- Integration specifications
66+
- API documentation
67+
- Testing strategies
68+
- Deployment procedures
69+
70+
## Core Workflows
71+
72+
### Plan Mode
73+
flowchart TD
74+
Start[Start] --> ReadFiles[Read Memory Bank]
75+
ReadFiles --> CheckFiles{Files Complete?}
76+
77+
CheckFiles -->|No| Plan[Create Plan]
78+
Plan --> Document[Document in Chat]
79+
80+
CheckFiles -->|Yes| Verify[Verify Context]
81+
Verify --> Strategy[Develop Strategy]
82+
Strategy --> Present[Present Approach]
83+
84+
### Act Mode
85+
flowchart TD
86+
Start[Start] --> Context[Check Memory Bank]
87+
Context --> Update[Update Documentation]
88+
Update --> Execute[Execute Task]
89+
Execute --> Document[Document Changes]
90+
91+
## Documentation Updates
92+
93+
Memory Bank updates occur when:
94+
1. Discovering new project patterns
95+
2. After implementing significant changes
96+
3. When user requests with **update memory bank** (MUST review ALL files)
97+
4. When context needs clarification
98+
99+
flowchart TD
100+
Start[Update Process]
101+
102+
subgraph Process
103+
P1[Review ALL Files]
104+
P2[Document Current State]
105+
P3[Clarify Next Steps]
106+
P4[Document Insights & Patterns]
107+
108+
P1 --> P2 --> P3 --> P4
109+
end
110+
111+
Start --> Process
112+
113+
Note: When triggered by **update memory bank**, I MUST review every memory bank file, even if some don't require updates. Focus particularly on activeContext.md and progress.md as they track current state.
114+
115+
REMEMBER: After every memory reset, I begin completely fresh. The Memory Bank is my only link to previous work. It must be maintained with precision and clarity, as my effectiveness depends entirely on its accuracy.

‎memory-bank/activeContext.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Active Context
2+
3+
*This file tracks the current work focus, recent changes, next steps, active decisions, important patterns, and project insights.*
4+
5+
## Current Focus
6+
7+
- What is the primary task or feature being worked on right now?
8+
9+
## Recent Changes
10+
11+
- List of significant changes made recently.
12+
- Include links to relevant commits or PRs if applicable.
13+
14+
## Next Steps
15+
16+
- What are the immediate next actions to be taken?
17+
- Outline the plan for the near future.
18+
19+
## Active Decisions & Considerations
20+
21+
- Record any ongoing discussions or decisions being made.
22+
- Note any important considerations influencing the current work.
23+
24+
## Important Patterns & Preferences
25+
26+
- Document any newly identified coding patterns or architectural choices.
27+
- Note any specific preferences expressed by the user or team.
28+
29+
## Learnings & Insights
30+
31+
- Capture any key learnings or insights gained during the recent work.

‎memory-bank/productContext.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Product Context
2+
3+
*This file describes why this project exists, the problems it solves, how it should work, and the user experience goals.*
4+
5+
## Problem Statement
6+
7+
- What problem(s) does this project aim to solve?
8+
9+
## Target Audience
10+
11+
- Who are the primary users of this project?
12+
13+
## How it Works
14+
15+
- High-level description of the project's functionality.
16+
17+
## User Experience Goals
18+
19+
- What are the key aspects of the desired user experience?

‎memory-bank/progress.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Progress
2+
3+
*This file tracks what works, what's left to build, the current status, known issues, and the evolution of project decisions.*
4+
5+
## What Works
6+
7+
- List features or components that are implemented and functioning correctly.
8+
9+
## What's Left to Build
10+
11+
- Outline the remaining tasks, features, or components.
12+
- Refer to `projectbrief.md` for scope.
13+
14+
## Current Status
15+
16+
- Provide a snapshot of the project's overall progress.
17+
- Mention any blockers or critical dependencies.
18+
19+
## Known Issues
20+
21+
- Document any bugs, limitations, or areas needing improvement.
22+
23+
## Evolution of Decisions
24+
25+
- Track significant changes in direction or approach over time.
26+
- Explain the reasons for these shifts.

‎memory-bank/projectbrief.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Project Brief
2+
3+
*This file is the foundation document that shapes all other Memory Bank files. It defines the core requirements and goals of the project and serves as the source of truth for the project scope.*
4+
5+
## Core Requirements
6+
7+
- [ ] Requirement 1
8+
- [ ] Requirement 2
9+
- [ ] ...
10+
11+
## Project Goals
12+
13+
- A VS Code Extension for users of Gitpod Classic
14+
- The extension prioritizes establishing a local SSH connection and then proxies SSH traffic over a websocket to Gitpod's ws-proxy component via HTTPS (TCP/443), and the supervisor process in the target workspace. If the websocket connection cannot be established, or the configuration prefers, SSH traffic is instead done over the SSH gateway component via TCP/22.
15+
16+
## Scope
17+
18+
### In Scope
19+
20+
- Feature A
21+
- Feature B
22+
23+
### Out of Scope
24+
25+
- Feature X
26+
- Feature Y

‎memory-bank/systemPatterns.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# System Patterns
2+
3+
*This file documents the system architecture, key technical decisions, design patterns in use, component relationships, and critical implementation paths.*
4+
5+
## System Architecture
6+
7+
- High-level overview of the system's structure.
8+
- Include diagrams (e.g., Mermaid) if helpful.
9+
10+
## Key Technical Decisions
11+
12+
- Record significant architectural or technical choices made.
13+
- Explain the reasoning behind these decisions.
14+
15+
## Design Patterns
16+
17+
- List the major design patterns employed in the codebase.
18+
- Provide examples of their usage.
19+
20+
## Component Relationships
21+
22+
- Describe how different parts of the system interact.
23+
- Detail dependencies between components.
24+
25+
## Critical Implementation Paths
26+
27+
- Highlight key workflows or data flows within the system.

‎memory-bank/techContext.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Tech Context
2+
3+
*This file details the technologies used, development setup, technical constraints, dependencies, and tool usage patterns.*
4+
5+
## Technologies Used
6+
7+
- List the primary programming languages, frameworks, and libraries.
8+
9+
## Development Setup
10+
11+
- Instructions for setting up the development environment.
12+
- Include necessary tools and configurations.
13+
14+
## Technical Constraints
15+
16+
- Note any limitations or constraints affecting development (e.g., browser compatibility, performance targets).
17+
18+
## Dependencies
19+
20+
- List major external dependencies (e.g., APIs, services).
21+
- Describe how they are integrated.
22+
23+
## Tool Usage Patterns
24+
25+
- Document common commands, scripts, or workflows used during development.

0 commit comments

Comments
 (0)