From 77031c3f21bd100acbac838d0b02f5f04bf66188 Mon Sep 17 00:00:00 2001 From: "Begonia, HE" <163421589+BegoniaHe@users.noreply.github.com> Date: Fri, 16 Jan 2026 05:51:41 +0100 Subject: docs(github): add commit helper agent and references - Add commit.agent.md with branch validation workflow - Include commit instructions for AI coding assistants - Add Conventional Commits specification reference - Implement Step 0 branch checking before commits Reviewed-by: Claude Sonnet 4.5 --- .github/instructions/commit.instructions.md | 38 +++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/instructions/commit.instructions.md (limited to '.github/instructions/commit.instructions.md') diff --git a/.github/instructions/commit.instructions.md b/.github/instructions/commit.instructions.md new file mode 100644 index 0000000..cc29e9c --- /dev/null +++ b/.github/instructions/commit.instructions.md @@ -0,0 +1,38 @@ +--- +applyTo: "**" +--- + +# Commit Helper Instructions + +When user requests commit help → Follow .github/agents/commit.agent.md + +## Critical Rules + +1. **Language**: Commit message ALWAYS in **English** (unless user specifies otherwise) +2. **Explanation**: Use **user's request language** ONLY when commit language differs + - Chinese user + English commit → Explain in Chinese + - English user + Chinese commit → Explain in English + - Same language → No extra explanation needed +3. **Confirmation**: ALWAYS ask before committing (unless "commit directly" requested) + +## Quick Reference + +**Format**: `[scope]: ` + +**Common types**: `feat` `fix` `docs` `refactor` `perf` `test` `chore` + +**AI commits MUST include**: `Reviewed-by: [MODEL_NAME]` + +**Spec**: .github/references/git/conventional-commit.md + +## Common Mistakes + +| Wrong | Right | +|-------|-------| +| `feat: Added feature` | `feat: add feature` (imperative) | +| `Fix bug.` | `fix: resolve auth issue` (lowercase, no period) | +| `feat: add A, refactor B, update C` | Split into 3 commits | + +## User Triggers + +"create commit", "commit message", "conventional commit" \ No newline at end of file -- cgit v1.2.3-70-g09d2 From e78e4e4f54b60bfc98dcf80ad5f3387b28999287 Mon Sep 17 00:00:00 2001 From: HsiangNianian <44714368+HsiangNianian@users.noreply.github.com> Date: Fri, 16 Jan 2026 07:48:54 +0000 Subject: chore: apply prek auto-fixes [skip ci] --- .github/agents/commit.agent.md | 2 +- .github/instructions/commit.instructions.md | 2 +- .gitignore | 2 +- CNAME | 2 +- README.md | 1 - src-tauri/Cargo.toml | 1 - src-tauri/icons/icon.svg | 2 +- ui/public/vite.svg | 2 +- ui/src/assets/svelte.svg | 2 +- ui/src/components/VersionsView.svelte | 1 - 10 files changed, 7 insertions(+), 10 deletions(-) (limited to '.github/instructions/commit.instructions.md') diff --git a/.github/agents/commit.agent.md b/.github/agents/commit.agent.md index 13372e5..7187402 100644 --- a/.github/agents/commit.agent.md +++ b/.github/agents/commit.agent.md @@ -257,4 +257,4 @@ git commit --amend -m "" ## References -- Commit spec: .github/references/git/conventional-commit.md \ No newline at end of file +- Commit spec: .github/references/git/conventional-commit.md diff --git a/.github/instructions/commit.instructions.md b/.github/instructions/commit.instructions.md index cc29e9c..f01f080 100644 --- a/.github/instructions/commit.instructions.md +++ b/.github/instructions/commit.instructions.md @@ -35,4 +35,4 @@ When user requests commit help → Follow .github/agents/commit.agent.md ## User Triggers -"create commit", "commit message", "conventional commit" \ No newline at end of file +"create commit", "commit message", "conventional commit" diff --git a/.gitignore b/.gitignore index 1c6830d..4d4229e 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,4 @@ node_modules/ # Python Build dist/ -__pycache__/ \ No newline at end of file +__pycache__/ diff --git a/CNAME b/CNAME index ed64ffa..b35b671 100644 --- a/CNAME +++ b/CNAME @@ -1 +1 @@ -dropout.hydroroll.team \ No newline at end of file +dropout.hydroroll.team diff --git a/README.md b/README.md index e3841f2..8bd2e56 100644 --- a/README.md +++ b/README.md @@ -114,4 +114,3 @@ Contributions are welcome! Please feel free to submit a Pull Request. [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_large) Distributed under the MIT License. See `LICENSE` for more information. - diff --git a/src-tauri/Cargo.toml b/src-tauri/Cargo.toml index ab6a063..62858cf 100644 --- a/src-tauri/Cargo.toml +++ b/src-tauri/Cargo.toml @@ -45,4 +45,3 @@ section = "games" assets = [ ["target/release/dropout", "usr/bin/", "755"], ] - diff --git a/src-tauri/icons/icon.svg b/src-tauri/icons/icon.svg index d8b0ed7..0baf00f 100644 --- a/src-tauri/icons/icon.svg +++ b/src-tauri/icons/icon.svg @@ -47,4 +47,4 @@ - \ No newline at end of file + diff --git a/ui/public/vite.svg b/ui/public/vite.svg index e7b8dfb..ee9fada 100644 --- a/ui/public/vite.svg +++ b/ui/public/vite.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/ui/src/assets/svelte.svg b/ui/src/assets/svelte.svg index c5e0848..8c056ce 100644 --- a/ui/src/assets/svelte.svg +++ b/ui/src/assets/svelte.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/ui/src/components/VersionsView.svelte b/ui/src/components/VersionsView.svelte index ce354b9..063c28d 100644 --- a/ui/src/components/VersionsView.svelte +++ b/ui/src/components/VersionsView.svelte @@ -236,4 +236,3 @@ - -- cgit v1.2.3-70-g09d2