Merge pull request #1 from u-hossy/init-setup

GitHubのリポジトリのセットアップ

Author: u-hossy

.github/workflows/actionlint.yml

@@ -0,0 +1,19 @@
+name: Lint GitHub Actions workflows
+on: push
+
+jobs:
+  actionlint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download actionlint
+        id: get_actionlint
+        run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
+        shell: bash
+      - name: Check workflow files
+        run: ${{ steps.get_actionlint.outputs.executable }} -color
+        shell: bash

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Git・GitHub関連の開発規則
+
+## ブランチの命名規則
+
+> 未定。決まり次第書きます
+
+## コミット・コミットメッセージの書き方
+
+- コミットメッセージの書き方に具体的なルールは設けませんが、**最低限どのような変更を加えたのかを明記してください**
+- バグを特定する際などに過去のバージョンを参照することがあります。まとめてコミットすると特定の状態に戻りにくくなるので、**こまめにコミットしておくことを推奨します**
+
+## Pull Requestの作成
+
+- `main`ブランチに直接Pushすることは、緊急時を除き禁止です
+- 開発したものを`main`ブランチに反映させるときは、必ずPull Requestを作成してからマージしてください
+  - 詳しくは次の項目を参照してください
+
+## `main`ブランチにマージされるまで
+
+- まずはローカルで正しく動くことを確認してください
+  - 既知のバグを含んだ状態で`main`ブランチにマージすることは避けてください
+- **必ず必須のチェックが通ってから`main`ブランチにマージしてください**

README.md

@@ -1,2 +1,25 @@
-# project-experiment
+# プロジェクト実験
+
 学部3年後期、プロジェクト実験
+
+## 開発規則
+
+### Git・GitHub関連
+
+> ブランチの命名規則、コミットメッセージの書き方、Pull Requestからmainブランチへマージされるまでの流れなど
+
+[`CONTRIBUTING.md`](/CONTRIBUTING.md)を参照してください
+
+### コーディング規則
+
+> 関数名や変数名、処理の書き方など
+
+> → 開発で用いる言語やツールが決まってから記載します
+
+## ディレクトリ説明
+
+- `docs`: コーディング規則などを記載する予定です
+
+## 環境構築方法
+
+> プロジェクトの詳細が決まってから記載します

docs/README.md

@@ -0,0 +1,3 @@
+# `/docs`: ドキュメントディレクトリ
+
+> コーディング規則やトラブルシューティングなど、開発に直接関係する情報