Skip to content

Commit 5ba5c57

Browse files
committed
Add CLAUDE.md file
1 parent b831dff commit 5ba5c57

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CLAUDE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Claude Context for Gitpod
2+
3+
This file provides essential context for AI assistants working on the Gitpod codebase.
4+
5+
## Project Overview
6+
7+
Gitpod is a cloud development environment platform that provides automated, ready-to-code development environments for any Git repository. The platform consists of multiple interconnected services and components that work together to deliver seamless developer experiences.
8+
9+
## Memory Bank Structure
10+
11+
This repository maintains comprehensive documentation in the `memory-bank/` directory:
12+
13+
### Core Documentation
14+
- **[Project Brief](memory-bank/projectbrief.md)** - Foundation document defining core requirements and goals
15+
- **[Product Context](memory-bank/productContext.md)** - Why this project exists and problems it solves
16+
- **[System Patterns](memory-bank/systemPatterns.md)** - System architecture and key technical decisions
17+
- **[Tech Context](memory-bank/techContext.md)** - Technologies used and development setup
18+
- **[Active Context](memory-bank/activeContext.md)** - Current work focus and recent changes
19+
- **[Progress](memory-bank/progress.md)** - What works, what's left to build, and current status
20+
21+
### Component Documentation
22+
The `memory-bank/components/` directory contains detailed documentation for each service and component in the Gitpod platform. Start with **[components.md](memory-bank/components.md)** for an overview.
23+
24+
## Working with This Codebase
25+
26+
1. **Start by reading the memory bank** - Always begin by reviewing the core documentation files above to understand the current state and context
27+
2. **Component-specific work** - Refer to the relevant component documentation in `memory-bank/components/`
28+
3. **Architecture decisions** - Check `memory-bank/systemPatterns.md` for established patterns and conventions
29+
4. **Current focus** - Review `memory-bank/activeContext.md` for ongoing work and priorities
30+
31+
## Key Characteristics
32+
33+
- **Multi-service architecture** - Gitpod consists of dozens of interconnected services
34+
- **Kubernetes-native** - Designed to run on Kubernetes with cloud-native patterns
35+
- **Developer experience focus** - Every decision prioritizes developer productivity and experience
36+
- **Workspace lifecycle management** - Complex orchestration of development environments
37+
- **Security and isolation** - Strong emphasis on secure, isolated development environments
38+
39+
## Important Notes
40+
41+
- This is a production system serving thousands of developers
42+
- Changes should be thoroughly tested and follow established patterns
43+
- Security considerations are paramount given the multi-tenant nature
44+
- Performance and scalability are critical concerns
45+
- The codebase spans multiple languages (Go, TypeScript, Java) and technologies
46+
47+
Always refer to the memory bank documentation for the most current and detailed information about any aspect of the system.

0 commit comments

Comments
 (0)