agentleFS
sny-tanakasny-tanaka/tanacode/AGENTS.md

tanacode

AGENTS.md5 starsChanged 12 days agoMITView on GitHub

Claude Code と IDE をひとつのアプリ上で使えるようにする、macOS 用のデスクトップアプリです(Electron)。 このリポジトリでは日本語だけを使ってください。ユーザーへの返答・途中の報告・質問・コミットメッセージ・コードのコメント・ドキュメントは、すべて日本語で書きます(コード中の識別子や、ツール名・コマンドなどの固有名詞はそのままでかまいません)。ただし、Claude だけが読むもの(tanacode が Claude Code に足す MCP サーバーの説明 instructions・ツールごとの説明・ツールの結果やエラーとして Claude に返す文)は、英語で書きます。ここでいう「ツールごとの説明」は、tanacode の MCP のツールの定義に書く説明のことです。Claude がツールを呼ぶときに書く説明(Bash の description など)は、人が画面のタスクの一覧などで読むので、日本語で書きます。 画面は日本語と英語に対応しています。画面の文言はコードに直接書かず、src/shared/locales/ja.json(日本語)と en.json(英語)の両方に足して、コードでは t('名前空間.キー') で読みます。en.json の値は英語で書きます。書き方の決まりは CONTRIBUTING.md の「画面の言語」にあります。 文書は読む人ごとに分けています。README.md(概要・インストール)と GUIDE.md(使い方)は使う人向け、CONTRIBUTING.md(開発の仕方・仕組み・ソースの構成)は開発者向けです。どれも(SECURITY.md も)、名詞で止められるところは体言止め、動詞で終わる文は「です・ます」で書きます(例:「ワンクリックで作成。作成後に編集することもできます。」)。README だけは英語の README.en.md もあり、英語で書きます。README.md を直したら、README.en.md も同じ中身に直してください。機能を変えたら、読む人に合わせて該当する文書を直してください。「版」は単体で使わず、「バージョン」と書きます(「最新版」も「最新バージョン」に。「開発版」のような熟語はそのまま)。 画面の部品や CSS を直したときは、アプリを起動せずに Storybook(npm run storybook)で確かめます。 ときどき落ちる(flaky な)テストを見つけたら、CI の再実行で済ませないでください。落ちる原因を突き止めて、落ちないように直します。アプリの不具合が原因なら、アプリを直します(人が使っていても同じことが起こりうるため)。テストの書き方が原因なら、テストを直します。決まった時間を待つ・押し直すなどの回り道で隠すことはしません。直したら、手元で何回も流して、直す前より落ちなくなったことを確かめます。 ただし、再現のために過度に流し続けることはしません。手元で 2〜3 回流して再現しなければ、原因を突き止めるのはあきらめます。あきらめるときは、次に CI で落ちたときに原因を読めるよう、必要なログ(落ちた時点の画面の写し・状態など)が残るようにだけしておきます。 design/ にはアプリのロゴと、README の紹介画像(screenshot.png)が入っています。

The file

Files
AGENTS.md

Claude Code と IDE をひとつのアプリ上で使えるようにする、macOS 用のデスクトップアプリです(Electron)。

このリポジトリでは日本語だけを使ってください。ユーザーへの返答・途中の報告・質問・コミットメッセージ・コードのコメント・ドキュメントは、すべて日本語で書きます(コード中の識別子や、ツール名・コマンドなどの固有名詞はそのままでかまいません)。ただし、Claude だけが読むもの(tanacode が Claude Code に足す MCP サーバーの説明 instructions・ツールごとの説明・ツールの結果やエラーとして Claude に返す文)は、英語で書きます。ここでいう「ツールごとの説明」は、tanacode の MCP のツールの定義に書く説明のことです。Claude がツールを呼ぶときに書く説明(Bash の description など)は、人が画面のタスクの一覧などで読むので、日本語で書きます。

画面は日本語と英語に対応しています。画面の文言はコードに直接書かず、src/shared/locales/ja.json(日本語)と en.json(英語)の両方に足して、コードでは t('名前空間.キー') で読みます。en.json の値は英語で書きます。書き方の決まりは CONTRIBUTING.md の「画面の言語」にあります。

文書は読む人ごとに分けています。README.md(概要・インストール)と GUIDE.md(使い方)は使う人向け、CONTRIBUTING.md(開発の仕方・仕組み・ソースの構成)は開発者向けです。どれも(SECURITY.md も)、名詞で止められるところは体言止め、動詞で終わる文は「です・ます」で書きます(例:「ワンクリックで作成。作成後に編集することもできます。」)。README だけは英語の README.en.md もあり、英語で書きます。README.md を直したら、README.en.md も同じ中身に直してください。機能を変えたら、読む人に合わせて該当する文書を直してください。「版」は単体で使わず、「バージョン」と書きます(「最新版」も「最新バージョン」に。「開発版」のような熟語はそのまま)。

画面の部品や CSS を直したときは、アプリを起動せずに Storybook(npm run storybook)で確かめます。

ときどき落ちる(flaky な)テストを見つけたら、CI の再実行で済ませないでください。落ちる原因を突き止めて、落ちないように直します。アプリの不具合が原因なら、アプリを直します(人が使っていても同じことが起こりうるため)。テストの書き方が原因なら、テストを直します。決まった時間を待つ・押し直すなどの回り道で隠すことはしません。直したら、手元で何回も流して、直す前より落ちなくなったことを確かめます。

ただし、再現のために過度に流し続けることはしません。手元で 2〜3 回流して再現しなければ、原因を突き止めるのはあきらめます。あきらめるときは、次に CI で落ちたときに原因を読めるよう、必要なログ(落ちた時点の画面の写し・状態など)が残るようにだけしておきます。

design/ にはアプリのロゴと、README の紹介画像(screenshot.png)が入っています。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.