FAF Git - Basic Git Practices for .faf Files

Purpose

Guide users on basic Git practices for

project.faf

and

CLAUDE.md

files. Covers committing, sharing, and repository setup - NOT a comprehensive GitHub guide.

The Goal: Help users share project context correctly. Keep .faf files version controlled.

When to Use

This skill activates when the user:

• Asks "Should I commit project.faf?"
• Says "Add FAF to Git"
• Asks "How do I share my project.faf?"
• Says "Put on GitHub"
• Needs .gitignore guidance for .faf files

Trigger Words: commit, git, github, share, version control, repository, gitignore

Basic Git Practices

YES - Commit These Files

Always commit:

git add project.faf
git add CLAUDE.md
git add README.md
git commit -m "feat: add project context files

- Initialize project.faf (IANA-registered format)
- Add CLAUDE.md workflow instructions
- Enable persistent AI context"

Why:

• project.faf = Project DNA (team benefits)
• CLAUDE.md = Workflow rules (consistency)
• Automatic pickup by teammates' AI tools

NO - Don't Commit These

Never commit:

# Backup files
project.faf.backup
project.faf.backup-*

# Personal AI configs (if sensitive)
.claude/   # Personal skills/configs

.gitignore pattern:

# FAF backups
*.faf.backup*

Basic Sharing Workflow

Initial setup:

# 1. Create project.faf
faf init

# 2. Review and enhance
faf enhance

# 3. Commit to repository
git add project.faf CLAUDE.md
git commit -m "feat: add AI context files"

# 4. Push to remote
git push origin main

Result: Team members' AI tools automatically read project.faf.

.gitignore Best Practices

Minimal .gitignore for FAF:

# FAF Backups
*.faf.backup*
project.faf.backup

# Personal configs (optional)
.faf/personal-notes.md

Note: This is minimal. Full .gitignore depends on your project type.

Common Questions

Q: Should everyone on the team commit project.faf? A: One person creates it, everyone benefits. Just commit once.

Q: How often do I commit updates? A: Only when architecture changes (framework upgrade, major refactor).

Q: What if someone else edited project.faf? A: Use

faf bi-sync

to resolve, then commit merged version.

Q: Do I need project.faf in every branch? A: Helpful but not required. Main branch should always have it.

---

Generated by FAF Skill: faf-git v1.0.0 "Commit project DNA. Share with your team. Everyone benefits."