Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.77 KB

File metadata and controls

47 lines (31 loc) · 2.77 KB

AGENTS.md: AIエージェント向け開発ガイド (Dotfiles)

このドキュメントは、AIエージェントがこのdotfilesリポジトリで効率的に作業を進めるためのガイドラインです。

1. プロジェクト概要

このリポジトリは、macOS開発環境をセットアップするための個人の設定ファイル(dotfiles)と自動化スクリプトを管理しています。 zsh, vim, git などの設定と、Homebrewを使ったツールのインストールを自動化することを目的としています。

2. 開発ルール

  • 日本語で応答してください
  • コミットは小さく、細かくが望ましいです
    • 1つの作業やコミットで複数のことを行わないでください。例えば機能追加のコミットとリファクタリングのコミットを混ぜないでください。

3. 主要なファイルとスクリプト

  • Brewfile: HomebrewでインストールするCLIツールやGUIアプリケーションのリストです。新しいツールを追加する場合はこのファイルを編集します。
  • setup1-brew.sh: Brewfile の内容に基づいてツールをインストールします。
  • setup2-git.sh: Gitのグローバル設定を行います。
  • setup3-macdefaults.sh: macOSのシステム設定(Dock、Finderなど)を変更します。
  • setup4-rc.sh: リポジトリ内の設定ファイル(.zshrc, .vimrcなど)をホームディレクトリにシンボリックリンクします。
  • .zshrc: Zshのメイン設定ファイルです。
  • .vimrc, dein.toml: Vimのメイン設定ファイルとプラグインリストです。
  • starship.toml: Starship プロンプトの設定ファイルです。

4. 一般的なタスクの進め方

新しいツールを追加する場合

  1. Brewfilebrew "tool-name" または cask "app-name" を追記します。
  2. ターミナルで brew bundle を実行するか、setup1-brew.sh を再実行します。

シェル設定を変更する場合

  1. .zshrc ファイルを編集します。
  2. 変更を適用するには、ターミナルを再起動するか source ~/.zshrc を実行します。

Vim設定を変更する場合

  1. 一般的な設定は .vimrc を編集します。
  2. プラグインを追加・削除する場合は dein.toml を編集します。

4. テストについて

このリポジトリには自動化されたテストスイートはありません。 変更が正しく行われたかは、セットアップスクリプトを(必要に応じて)再実行し、関連するアプリケーション(ターミナル、Vimなど)の動作を目視で確認することで検証します。