Skip to content

chore(community): add community standards, templates and workflows#36

Open
whats2000 wants to merge 2 commits intoai-twinkle:rollingfrom
whats2000:chore/community-standards
Open

chore(community): add community standards, templates and workflows#36
whats2000 wants to merge 2 commits intoai-twinkle:rollingfrom
whats2000:chore/community-standards

Conversation

@whats2000
Copy link
Member

描述

此 PR 建立了專案的社群規範、貢獻指南以及自動化流程。詳細包含:

  • 新增 CODE_OF_CONDUCT.md (繁體中文)
  • 新增 CONTRIBUTING.md (繁體中文,規範使用 Bun、Rolling 開發模式與英文 Commit)
  • 新增 Issue 與 PR 模板
  • 新增 auto-label CI Workflow

變更類型

請刪除不相關的選項。

  • 新功能 (非破壞性更改,增加了功能)
  • 錯誤修復 (非破壞性更改,修復了問題)
  • 文檔更新
  • 重構 (沒有功能更改,沒有 API 更改)
  • 構建/CI 相關更改

這已經過測試了嗎?

請描述您運行的測試以驗證您的更改。

  • 確認文件內容準確且為繁體中文
  • 確認 Workflow 設定檔格式正確

檢查清單:

  • 我的代碼遵循此專案的風格指南
  • 我已經對自己的代碼進行了自我審查
  • 我已經註釋了我的代碼,特別是在難以理解的區域
  • 我已經對文檔進行了相應的更改
  • 我已經檢查了我的 commit 訊息是否遵循 Conventional Commits 格式
  • 我的更改沒有產生新的警告

Copilot AI review requested due to automatic review settings February 7, 2026 09:26
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

此 PR 為專案建立社群協作的基礎設施:新增社群規範文件、Issue/PR 模板,並加入自動標籤的 GitHub Actions workflow,以提升貢獻流程一致性與維護效率。

Changes:

  • 新增繁體中文的 CODE_OF_CONDUCT.mdCONTRIBUTING.md
  • 新增 PR / Issue 模板(feature request、bug report)
  • 新增 Auto Label workflow 與 labeler 規則設定

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
CONTRIBUTING.md 新增貢獻流程與提交規範(Bun / Husky / Conventional Commits)
CODE_OF_CONDUCT.md 新增 Contributor Covenant 2.1(繁中)行為準則
.github/workflows/auto-label.yml 新增 PR 自動套用 label 的 workflow
.github/labeler.yml 定義依檔案路徑/類型套用的標籤規則
.github/PULL_REQUEST_TEMPLATE.md 新增 PR 模板(繁中)
.github/ISSUE_TEMPLATE/feature_request.md 新增功能請求 Issue 模板(繁中)
.github/ISSUE_TEMPLATE/bug_report.md 新增錯誤回報 Issue 模板(繁中)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- uses: actions/labeler@v5
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
sync-labels: true
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sync-labels: true 會在檔案變更不再匹配時移除 labeler 管理的標籤;若團隊會手動加上同名標籤(如 frontend/backend),也可能被自動移除。請確認這個行為符合預期;若不希望自動移除,建議關閉此選項。

Copilot uses AI. Check for mistakes.
Comment on lines +13 to +16
- uses: actions/labeler@v5
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
sync-labels: true
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

steps: 下的 list item 需要再縮排一層;目前 - uses:steps: 同層會造成 workflow YAML 無法解析,導致 Auto Label 不會執行。請把步驟縮排成 steps: 之下的陣列。

Suggested change
- uses: actions/labeler@v5
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
sync-labels: true
- uses: actions/labeler@v5
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
sync-labels: true

Copilot uses AI. Check for mistakes.
Comment on lines +19 to +21
* **`main`**: 主要分支,隨時保持可部署狀態 (Rolling Release)。所有的 Pull Request 都應該合併回此分支。
* **`feature/*`**: 用於開發新功能的分支 (例如: `feature/new-login-page`)。
* **`fix/*`**: 用於修復錯誤的分支 (例如: `fix/login-bug`)。
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

分支策略段落寫的是 feature/*,但下方建立分支示例使用的是 feat/...。請統一分支前綴(例如都用 feature/* 或都用 feat/*),避免貢獻者依文件操作時產生混淆。

Copilot uses AI. Check for mistakes.

1. 為您的功能或錯誤修復創建一個新的分支:
```bash
git checkout -b feat/your-feature-name
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

這裡的 git checkout -b feat/... 與前文列出的 feature/* 分支命名不一致。若專案約定是 feature/*,請同步更新此命令;反之亦然。

Suggested change
git checkout -b feat/your-feature-name
git checkout -b feature/your-feature-name

Copilot uses AI. Check for mistakes.
Comment on lines +37 to +42
我們使用 `husky` 來確保代碼品質。在您提交 (commit) 之前,`lint-staged` 會自動執行以檢查您的代碼風格。

您也可以手動執行 lint 檢查:
```bash
bun run lint
```
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

文件建議手動執行 bun run lint,但目前 package.jsonlint script 是 lint-staged,通常只適用於已 staged 的檔案。若要提供手動檢查整個專案的方式,建議改指向 lint:es:check(或提供 lint:es:fix)等不依賴 git stage 的指令。

Suggested change
我們使用 `husky` 來確保代碼品質。在您提交 (commit) 之前,`lint-staged` 會自動執行以檢查您的代碼風格。
您也可以手動執行 lint 檢查:
```bash
bun run lint
```
我們使用 `husky` 來確保代碼品質。在您提交 (commit) 之前,`lint-staged` 會自動執行以檢查您的代碼風格(此時執行的是 `lint` script,僅針對已 staged 的檔案)。
若要**手動檢查整個專案**的程式碼風格,請執行:
```bash
bun run lint:es:check
```
若要在檢查的同時盡可能自動修正問題,則可改用:
```bash
bun run lint:es:fix
```

Copilot uses AI. Check for mistakes.

## 我們的標準

有助於創造積環境的行為示例包括:
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

此處「積環境」疑似漏字,會影響閱讀理解;請修正為「積極環境」(或等價用語)。

Suggested change
有助於創造積環境的行為示例包括
有助於創造積極環境的行為示例包括

Copilot uses AI. Check for mistakes.

## 執行

如發現濫用、騷擾或其他不可接受的行為,可通過 [在此插入聯繫方式] 向負責執行的社區領導者報告。
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

行為準則的回報方式仍是佔位文字「[在此插入聯繫方式]」。這會讓實際執行流程無法落地;請替換成真實的聯絡管道(例如專案 email、維護者名單、或指向特定的回報表單/Issue 途徑)。

Suggested change
如發現濫用、騷擾或其他不可接受的行為,可通過 [在此插入聯繫方式] 向負責執行的社區領導者報告。
如發現濫用、騷擾或其他不可接受的行為,可通過電子郵件聯繫 project-maintainers@example.com 向負責執行的社區領導者報告。

Copilot uses AI. Check for mistakes.
@supersonictw supersonictw changed the base branch from main to rolling February 21, 2026 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants