Add project memory system with versioning guidelines
Establishes CLAUDE.md, CHANGELOG.md, and README.md as persistent project memory. Adds documentation update triggers and semantic versioning rules to ensure context is maintained across sessions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
b3ed5e66a5
commit
cbc379c0cc
2 changed files with 25 additions and 0 deletions
|
|
@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.8.0] - 2025-01-25
|
||||
|
||||
### Added
|
||||
- Project memory system using CLAUDE.md, CHANGELOG.md, and README.md
|
||||
- Versioning rules and documentation update guidelines in CLAUDE.md
|
||||
|
||||
## [0.7.0] - 2025-01-25
|
||||
|
||||
### Added
|
||||
|
|
|
|||
19
CLAUDE.md
19
CLAUDE.md
|
|
@ -1,5 +1,23 @@
|
|||
# CLAUDE.md
|
||||
|
||||
## Project Memory
|
||||
|
||||
This project uses three documentation files as persistent memory. **You must keep these files up to date when making changes:**
|
||||
|
||||
| File | Purpose | Update When |
|
||||
|------|---------|-------------|
|
||||
| `CLAUDE.md` | Technical context for Claude Code sessions | Adding new patterns, conventions, or implementation details |
|
||||
| `CHANGELOG.md` | Version history following Keep a Changelog format | Every commit (add entry, bump version) |
|
||||
| `README.md` | User-facing documentation | Changing user-visible behavior, adding features, or modifying usage |
|
||||
|
||||
### Versioning Rules
|
||||
|
||||
- Use semantic versioning (MAJOR.MINOR.PATCH)
|
||||
- Increment PATCH for bug fixes and minor updates
|
||||
- Increment MINOR for new features and enhancements
|
||||
- Increment MAJOR for breaking changes
|
||||
- Tag every commit with its version: `git tag -a vX.Y.Z -m "Description"`
|
||||
|
||||
## Project Overview
|
||||
|
||||
This repository contains a dual-mode setup script for creating OrbStack-based development sandboxes tailored for Claude Code with Elixir/Erlang, browser automation, and PostgreSQL.
|
||||
|
|
@ -12,6 +30,7 @@ config.env.example - Example credentials file
|
|||
config.env - User credentials (gitignored, created on first run)
|
||||
.gitignore - Ignores config.env
|
||||
README.md - User-facing documentation
|
||||
CHANGELOG.md - Version history (Keep a Changelog format)
|
||||
CLAUDE.md - This file (context for Claude Code sessions)
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue