Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.21 KB

AGENTS.md

File metadata and controls

50 lines (32 loc) · 2.21 KB

プロジェクト ポリシー

主に当該リポジトリの内容を、

https://github.com/OpenTouryoProject/OpenTouryo/wiki

に移行する作業を行う。

コンテンツ作成

  • 日本語版コンテンツの拡張子は、*.ja.*とする。

  • 作業範囲「XXXXX」(例:UserGuide → フォルダ名は全て小文字にする)で、

    • マークダウン配置位置「..\OpenTouryo.wiki\XXXXX」
    • イメージ配置位置「..\OpenTouryo.wiki\images\XXXXX\YYYY\」
      • YYYYはマークダウンを識別できる文字列で、
      • 短いセクション名を使用(UserGuide_IndexならIndex)。

GitHubの操作

gh で認証し、gitで操作する。

ただし、人の作業状態や未保存の作業を壊すので、以下の操作は行わない。

  • git checkout / switch / branch / reset / restore / stash

画像ファイル

  • 画像は新規作成時も更新時もpushしない。
  • 画像は品質に問題があるケースがあるのでエージェントは作業結果をワーキング ツリーに残すところまでを担当
  • なお、画像が取得出来なかった場合も、Markdownファイル側にはキャプションの文字列は記入すること。

Markdownファイル

新規作成時を除き、更新操作においてMarkdownファイルの検収は人が行う。

エージェントは作業結果をワーキング ツリーに残すところまでを担当し、Git 操作は人が手動で行う。

従って、Markdownファイル更新操作において指示がない限り次を実行して検収前・未レビューの変更を確定・送信しない。

  • git commit / push

修正作業が完了したら何を変更したかを報告するに留める。コミットの要否とタイミングは人が判断する。