From b7138b3ecf15b79f4d014d1f0cf68dd723f107ab Mon Sep 17 00:00:00 2001 From: mayurrawte Date: Fri, 15 May 2026 14:00:44 +0530 Subject: [PATCH] docs: add CLAUDE.md with team workflow guidelines --- CLAUDE.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..1d02fce --- /dev/null +++ b/CLAUDE.md @@ -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/`, `bug/`, `hotfix/`, `release/` (lowercase, hyphens). +- **Commit messages:** concise and descriptive. No AI mentions.