GitHub Setup Guide

This file helps you set up the GitHub repository with proper metadata.

Step 1: Create Repository on GitHub

1. Go to https://github.com/new

2. Fill in:

   • Repository name: claude-memory
   • Description: Share Claude sessions & hand off work between team members. Team collaboration without enterprise paywall.
   • Visibility: Public
   • Initialize: None (don't create README, .gitignore, or license)

3. Click "Create repository"

Step 2: Push Code

git remote add origin https://github.com/YOUR_USERNAME/claude-memory.git
git branch -M main
git push -u origin main

Step 3: Add Repository Settings

Topics

Add these topics to help people find the project:

• claude
• mcp
• team-collaboration
• session-sharing
• handoff
• ai
• open-source

How: Settings → About → Topics

Description

Already set in README, but GitHub's short description:

Persistent memory for Claude that survives session compaction

License

Already set to MIT in LICENSE file.

Social Preview

• Set a custom image (optional)
• Use project logo when ready

Step 4: Configure Collaborators (Optional)

If adding team members:

• Settings → Collaborators → Invite

Step 5: Enable Discussions (Optional)

• Settings → Features → Discussions (✓ Enable)

Useful for Q&A and feature discussions.

Step 6: Branch Protection (Optional)

For production-ready projects:

1. Settings → Branches → Add rule
2. Branch name pattern: main
3. Check:
   • ✓ Require pull request reviews
   • ✓ Require status checks to pass
   • ✓ Require branches to be up to date

Step 7: Update GitHub URLs

Find and replace in files:

• yourusername → Your actual GitHub username
• YOUR_USERNAME → Your actual GitHub username

Common files:

• README.md
• CONTRIBUTING.md
• .github/FUNDING.yml
• .github/workflows/

# Quick find
grep -r "yourusername" . --include="*.md" --include="*.yml"

# Replace (macOS/Linux)
sed -i 's/yourusername/YOUR_USERNAME/g' *.md .github/*.yml

# Replace (Windows PowerShell)
# Get-ChildItem -Recurse -Include "*.md","*.yml" | ForEach-Object {
#   (Get-Content $_) -replace 'yourusername','YOUR_USERNAME' | Set-Content $_
# }

Step 8: Test Workflows

Push a commit to trigger GitHub Actions:

git commit --allow-empty -m "test: trigger CI/CD workflows"
git push

Check: Actions tab → See workflows running

Step 9: Add Badges to README

When you have a repository, update README badges:

![GitHub Stars](https://img.shields.io/github/stars/YOUR_USERNAME/claude-memory?style=social)
![License](https://img.shields.io/badge/License-MIT-yellow.svg)
![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)