-
Notifications
You must be signed in to change notification settings - Fork 1
Document developer workflow conventions #14
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Claude Code Notes | ||
|
|
||
| Canonical behavior contract for this repo is [`AGENTS.md`](AGENTS.md) — read | ||
| it first. This file adds Claude-specific context so a session that only | ||
| loads `CLAUDE.md` still has the essentials. | ||
|
|
||
| ## Language | ||
| Respond in Russian. Code, git commit messages, and CLI output stay in English. | ||
|
|
||
| ## Scope | ||
| Three coupled surfaces — prefer the more specific `mcp/AGENTS.md` / | ||
| `mcp/CLAUDE.md` and `control-plane/AGENTS.md` when working inside those | ||
| directories: | ||
| - `mcp/` — Telegram MCP server and live tool behavior. | ||
| - `control-plane/` — local operator commands, release checks, agent docs. | ||
| - `plugin/` — packaged Codex plugin and bundled Telegram skill. | ||
|
|
||
| ## Developer Workflow (summary — see `AGENTS.md` for the full derivation) | ||
|
|
||
| - **Branch**: `claude/<topic-slug>` for work you start (mirrors the repo's | ||
| established `codex/<topic-slug>` convention; do not invent another prefix). | ||
| - **Commit message**: single-line, capitalized, imperative summary | ||
| (`Add X`, `Harden Y`) — no type prefix required; this repo doesn't use | ||
| conventional commits consistently. Bullet body only for multi-part changes. | ||
| - **Attribution**: this repo's own history carries no `Co-Authored-By` | ||
| trailers, but keep Claude Code's default trailer on commits you author — | ||
| it's accurate disclosure, just don't backfill it onto older commits. | ||
| - **PR body**: `## Summary` (bullets) + `## Verification` (exact commands and | ||
| real output, not "tests pass") + optional `## GitHub context`. | ||
| - **Before committing anything non-trivial**: run `scripts/safe-gate`. Quote | ||
| its actual output in the PR, don't paraphrase. | ||
| - **main**: default path is branch -> PR, never push directly to `main` | ||
| unless the user explicitly asks for that in the current request — an | ||
| earlier approval to push doesn't carry forward. | ||
|
|
||
| ## Commands | ||
|
|
||
| - `./scripts/safe-gate` — MCP tests + control-plane tests (portable mode) + | ||
| agent docs sync drift + whitespace hygiene. Run before every non-trivial | ||
| commit. | ||
| - `./scripts/ci-release-gate.sh` — full release verification. | ||
| - `PYTHONPATH=src .venv/bin/python -m unittest discover -s tests -p 'test_*.py'` | ||
| — run from `mcp/` directly when iterating on that surface. Zero extra deps. | ||
| `CONTRIBUTING.md` shows `pytest` instead — that also works, but `pytest` | ||
| isn't a declared dependency, so a fresh `.venv` needs | ||
| `uv pip install pytest` before `uv run pytest` will find it. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When an agent follows this new PR-body guidance, it will produce only
Summary/Verification/optionalGitHub context, but.github/PULL_REQUEST_TEMPLATE.mdstill requires theLayer,Checks, andSafetychecklists. Saying this shape “should satisfy” the checklist makes future PRs omit those required boxes instead of filling them, so the workflow docs should either retain those template sections or explicitly instruct agents to fill the template alongside the summary.Useful? React with 👍 / 👎.