From cbc379c0cc0b0abb58405a40b44d480bb5c79cce Mon Sep 17 00:00:00 2001 From: guessthepw Date: Sun, 25 Jan 2026 09:29:37 -0500 Subject: [PATCH] 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 --- CHANGELOG.md | 6 ++++++ CLAUDE.md | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a64b357..2639fa7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/CLAUDE.md b/CLAUDE.md index 078501f..97050a0 100644 --- a/CLAUDE.md +++ b/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) ```