|
1 | 1 | # Repository Guidelines |
2 | 2 |
|
3 | | -この ドキュメント は この リポジトリ の 参加者 向け ガイド です。Android Java テンプレート として の 作業 を 迅速 に 始める ため、構成 と 基本 ルール を まとめます。 |
| 3 | +このドキュメントはリポジトリの参加者向けガイドです。Android Javaテンプレートとしての作業を迅速に始めるため、構成と基本ルールをまとめます。 |
4 | 4 |
|
5 | 5 | ## プロジェクト構成とモジュール |
6 | | -- ルート は Gradle Kotlin DSL 構成 で、`settings.gradle.kts` と `build.gradle.kts` が 入口。 |
7 | | -- アプリ 本体 は 単一 モジュール `app/`。Java ソース は `app/src/main/java/jp/ac/jec/cm0199/jecandroidjavatemplate/`。 |
8 | | -- リソース は `app/src/main/res/`、マニフェスト は `app/src/main/AndroidManifest.xml`。 |
9 | | -- 共有 設定 は `gradle/` と `gradle/libs.versions.toml` で 管理。 |
| 6 | +- ルートは Gradle Kotlin DSL 構成で、`settings.gradle.kts`と`build.gradle.kts`が入口。 |
| 7 | +- アプリ本体は単一モジュール `app/`。Javaソースは `app/src/main/java/jp/ac/jec/cm0199/jecandroidjavatemplate/`。 |
| 8 | +- リソースは `app/src/main/res/`、マニフェストは `app/src/main/AndroidManifest.xml`。 |
| 9 | +- 共有設定は `gradle/`と`gradle/libs.versions.toml`で管理。 |
10 | 10 |
|
11 | 11 | ## ビルド・テスト・開発コマンド |
12 | | -- `./gradlew assembleDebug` : デバッグ APK を 生成。 |
13 | | -- `./gradlew assembleRelease` : リリース APK を 生成(minify は 無効)。 |
14 | | -- `./gradlew installDebug` : 接続 端末 に インストール。 |
15 | | -- `./gradlew test` : JVM ユニット テスト(JUnit4)。 |
16 | | -- `./gradlew connectedAndroidTest` : 実機 / エミュレータ 向け 計測 テスト。 |
17 | | -- `./gradlew lint` : Android Lint を 実行。 |
| 12 | +- `./gradlew assembleDebug` : デバッグAPKを生成。 |
| 13 | +- `./gradlew assembleRelease` : リリースAPKを生成(minifyは無効)。 |
| 14 | +- `./gradlew installDebug` : 接続端末にインストール。 |
| 15 | +- `./gradlew test` : JVMユニットテスト(JUnit4)。 |
| 16 | +- `./gradlew connectedAndroidTest` : 実機 / エミュレータ向け 計測テスト。 |
| 17 | +- `./gradlew lint` : Android Lintを実行。 |
18 | 18 |
|
19 | 19 | ## コーディング規約と命名 |
20 | | -- Java 11 を 前提。インデント は 4 スペース、タブ 禁止。 |
21 | | -- クラス は PascalCase、メソッド / 変数 は lowerCamelCase。 |
22 | | -- リソース 名 は lower_snake_case。例: `activity_main.xml`, `@+id/btn_submit`。 |
23 | | -- 画面実装 は View System を採用する。 |
24 | | -- レイアウト は ConstraintLayout を 避け、必要 に 応じて LinearLayout など を 使用する。 |
25 | | -- ロジックも含めて処理 は Activityにまとめる。 |
26 | | -- EdgeToEdge を 有効 に し、システム バー の インセット を 処理する。 |
| 20 | +- Java 11を前提。インデントは4 スペース、タブ禁止。 |
| 21 | +- クラス は PascalCase、メソッド/変数はlowerCamelCase。 |
| 22 | +- リソース名はlower_snake_case。例:`activity_main.xml`,`@+id/btn_submit`。 |
| 23 | +- 画面実装は View Systemを採用する。 |
| 24 | +- レイアウトはConstraintLayoutを避け、必要に応じてLinearLayoutなどを使用する。 |
| 25 | +- ロジックも含めて処理はActivityにまとめる。 |
27 | 26 | - ダークテーマは非対応。 |
28 | 27 |
|
29 | | -## テスト方針 |
30 | | -- 単体 テスト は `app/src/test/java/`、計測 テスト は `app/src/androidTest/java/`。 |
31 | | -- 新規 修正 には 再現 テスト を 追加 し、`*Test.java` 命名 を 維持。 |
32 | | -- UI 変更 は Espresso の 追加 を 検討。 |
33 | | - |
34 | | -## コミット & PR |
35 | | -- `.git` が 無いため 既存 ルール を 確認 できない。短い 命令形 + 変更 内容(例: "Add settings screen")を 推奨。 |
36 | | -- PR には 目的、変更 点、実行 した コマンド を 記載。UI 変更 は スクリーンショット を 添付。 |
37 | | - |
38 | 28 | ## 設定・環境 |
39 | | -- `local.properties` は SDK パス 用。個人 環境 の 値 は 共有 しない。 |
40 | | -- 依存 バージョン 変更 は 影響 範囲 を 記録 し、`gradle/libs.versions.toml` を 更新。 |
| 29 | +- `local.properties`はSDKパス用。個人環境の値は共有しない。 |
| 30 | +- 依存バージョン変更は影響範囲を記録し、`gradle/libs.versions.toml`を更新。 |
41 | 31 |
|
42 | 32 | ## ドキュメント |
43 | 33 | - `README.md` : プロジェクト概要とセットアップ手順。 |
|
0 commit comments