Skip to content

Commit bc6dfd6

Browse files
committed
docs: add project purpose and principles to .claude.md
1 parent c62eea2 commit bc6dfd6

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

.claude.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5+
## Project Purpose
6+
7+
This is an **educational algorithms and data structures repository**. The core goal is to provide clear, well-tested, and accessible implementations for learners who may not have deep computer science backgrounds.
8+
9+
**Key Principles:**
10+
- **Every file should teach**, not just implement.
11+
- Implementations should be simple, elegant, and avoid unnecessary complexity (e.g., prefer plain loops over Java Streams).
12+
- Documentation must explain *how* and *why* an algorithm works, including time and space complexity.
13+
- Every algorithm must be accompanied by comprehensive tests that cover edge cases and teach through examples.
14+
515
## Build System
616

717
This project uses **Bazel** as its build system (requires JDK 8+). Dependencies are managed via Maven through `rules_jvm_external` and declared in `MODULE.bazel`.

0 commit comments

Comments
 (0)