|
| 1 | +--- |
| 2 | +description: 'Update the codebase information file.' |
| 3 | +--- |
| 4 | + |
1 | 5 | # Codebase |
2 | 6 |
|
3 | | -以下のファイルを更新してください。 |
4 | | -このファイルではAIがコードベースを理解する為の最低限の情報を管理します。このファイルが人間に読まれることはありません。英語で端的に記述してください。 |
| 7 | +Update the codebase information file that manages minimum information for AI to understand the codebase. This file will not be read by humans. |
| 8 | + |
| 9 | +Target file: @.github/instructions/~.instructions.md |
| 10 | + |
| 11 | +## Rules |
| 12 | + |
| 13 | +- Write in English |
| 14 | +- Keep content concise and minimal |
| 15 | +- Ensure information is up-to-date |
| 16 | +- Do NOT change section titles in the format |
| 17 | +- Only include important directories |
| 18 | +- Explore subdirectories as well |
| 19 | +- Ignore: directories starting with dots, configuration files, "docs" directory, items with obvious purposes |
| 20 | + |
| 21 | +## File Format |
5 | 22 |
|
6 | 23 | ``` |
7 | | -CODEBASE.md |
| 24 | +# Overview |
| 25 | +
|
| 26 | +[Product overview] |
| 27 | +
|
| 28 | +## Directory Structure |
| 29 | +
|
| 30 | +- `lib/api` - API |
| 31 | +- `lib/api/routes` - API routing |
| 32 | +
|
| 33 | +## Technical Features |
| 34 | +
|
| 35 | +- Remix |
| 36 | +- Shopify Hydrogen framework |
| 37 | +
|
| 38 | +## Appendix A (Optional) |
| 39 | +
|
| 40 | +[Additional information if needed] |
| 41 | +
|
| 42 | +## Appendix B (Optional) |
| 43 | +
|
| 44 | +[Additional information if needed] |
| 45 | +``` |
| 46 | + |
| 47 | +For monorepo, use the following format: |
| 48 | + |
8 | 49 | ``` |
| 50 | +# Overview |
| 51 | +
|
| 52 | +[Product overview] |
| 53 | +
|
| 54 | +### Directory Structure |
| 55 | +
|
| 56 | +[Overview] |
| 57 | +
|
| 58 | +- `packages/product-a` - Product A |
| 59 | +- `packages/product-b` - Product B |
9 | 60 |
|
10 | | -ディレクトリを探索してディレクトリ構成のメモを更新してください。 |
| 61 | +### Technical Features |
11 | 62 |
|
12 | | -- 重要なディレクトリのみを記載してください。 |
13 | | -- サブディレクトリも探索してください。 |
14 | | -- ディレクトリの説明は英語で記述してください。 |
15 | | -- 用途が明らかなものは無視してください。 |
| 63 | +[Overview] |
16 | 64 |
|
17 | | -以下のディレクトリやファイルは無視してください: |
| 65 | +- Remix |
| 66 | +- Shopify Hydrogen framework |
18 | 67 |
|
19 | | -- ディレクトリ「docs」 |
20 | | -- ドットから始まるディレクトリ |
21 | | -- 設定ファイル |
| 68 | +## Product A |
| 69 | +
|
| 70 | +[Product overview] |
| 71 | +
|
| 72 | +### Directory Structure |
| 73 | +
|
| 74 | +[Overview] |
| 75 | +
|
| 76 | +- `lib/api` - API |
| 77 | +- `lib/api/routes` - API routing |
| 78 | +
|
| 79 | +### Technical Features |
| 80 | +
|
| 81 | +[Overview] |
| 82 | +
|
| 83 | +- Remix |
| 84 | +- Shopify Hydrogen framework |
| 85 | +
|
| 86 | +## Product B |
| 87 | +
|
| 88 | +[Product overview] |
| 89 | +
|
| 90 | +### Directory Structure |
| 91 | +
|
| 92 | +[Overview] |
| 93 | +
|
| 94 | +- `lib/api` - API |
| 95 | +- `lib/api/routes` - API routing |
| 96 | +
|
| 97 | +### Technical Features |
| 98 | +
|
| 99 | +[Overview] |
| 100 | +
|
| 101 | +- Remix |
| 102 | +- Shopify Hydrogen framework |
| 103 | +
|
| 104 | +## Appendix A (Optional) |
| 105 | +
|
| 106 | +[Additional information if needed] |
| 107 | +
|
| 108 | +## Appendix B (Optional) |
| 109 | +
|
| 110 | +[Additional information if needed] |
| 111 | +``` |
0 commit comments