Skip to content

docs: add CLAUDE.md with team workflow guidelines #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mayurrawte wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −0
Open

docs: add CLAUDE.md with team workflow guidelines #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CLAUDE.md

## Overview
Python SDK package for the Shipthis public API — a pip-installable wrapper (`shipthisapi-python`) that simplifies making authenticated API calls to the Shipthis logistics platform.

## Team Workflow
For any non-trivial task (new feature, refactor, bug with unclear root cause):
1. **Brainstorm first** — invoke `superpowers:brainstorming` skill before writing code. Discuss context, edge cases, dependencies.
2. **Bug fixes** — invoke `superpowers:systematic-debugging` skill before proposing any fix. Trace root cause first, never guess.
3. **Plan before code** — invoke `superpowers:writing-plans` skill to produce a step-by-step implementation plan.
4. **Parallel execution** — invoke `superpowers:dispatching-parallel-agents` for independent steps.
5. **Verify before done** — invoke `superpowers:verification-before-completion` before declaring the task complete.

**Model selection:**
- `claude-opus-4-7` — planning, brainstorming, complex bugs, architecture decisions
- `claude-sonnet-4-6` — standard feature execution, moderate bug fixes
- `claude-haiku-4-5` — simple/mechanical tasks (copy, rename, boilerplate, trivial fixes)

Simple one-liner fixes and typos are exempt from this flow.

## Response Style
Be terse. Short answers only — offer to expand rather than expand by default.

## Git Rules
- **Never add Claude as co-author or author.** No `Co-Authored-By`, no AI mentions in commits.
- **Never push to `main` or `develop`** — always create a feature branch and PR.
- **Branch names:** `feature/<name>`, `bug/<name>`, `hotfix/<name>`, `release/<name>` (lowercase, hyphens).
- **Commit messages:** concise and descriptive. No AI mentions.