Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: "功能請求 / Feature Request"
description: "提出新功能或改進建議 / Suggest a new feature or improvement"
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
感謝您提出功能建議!請盡可能詳細地描述您的需求。
Thank you for your feature suggestion! Please describe your needs as detailed as possible.

- type: textarea
id: problem
attributes:
label: 問題描述 / Problem Description
description: 您希望解決什麼問題? / What problem would you like to solve?
placeholder: 清楚描述您遇到的問題或不便之處...
validations:
required: true

- type: textarea
id: solution
attributes:
label: 建議解決方案 / Proposed Solution
description: 您希望如何解決這個問題? / How would you like to solve this problem?
placeholder: 描述您理想中的解決方案...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: 替代方案 / Alternatives Considered
description: 您考慮過其他解決方案嗎? / Have you considered any alternative solutions?
placeholder: 描述您考慮過的其他方法...
validations:
required: false

- type: dropdown
id: category
attributes:
label: 功能類別 / Feature Category
description: 這個功能屬於哪個類別? / Which category does this feature belong to?
options:
- 📚 內容/文檔 (Content/Documentation)
- 💻 代碼示例 (Code Examples)
- 🧪 測試 (Testing)
- 🔧 工具/自動化 (Tools/Automation)
- 📖 學習路徑 (Learning Path)
- 🌐 國際化 (Internationalization)
- 🎨 UI/UX 改進 (UI/UX Improvement)
- 其他 (Other)
validations:
required: true

- type: textarea
id: additional
attributes:
label: 補充資訊 / Additional Context
description: 任何其他相關資訊 / Any other relevant information
placeholder: 截圖、參考連結等...
validations:
required: false

- type: checkboxes
id: contribution
attributes:
label: 貢獻意願 / Contribution
description: 您是否願意協助實現這個功能? / Would you like to help implement this feature?
options:
- label: 我願意提交 PR 來實現這個功能 / I'm willing to submit a PR for this feature
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: "問題諮詢 / Question"
description: "詢問關於專案的問題 / Ask a question about the project"
title: "[Question]: "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
歡迎提問!在提問之前,請先查閱:
- [README.md](https://github.com/markl-a/My-AI-Learning-Notes/blob/main/README.md)
- [學習路徑指南](https://github.com/markl-a/My-AI-Learning-Notes/blob/main/LEARNING_PATHS.md)
- [快速開始指南](https://github.com/markl-a/My-AI-Learning-Notes/blob/main/QUICKSTART.md)

Welcome! Before asking, please check the documentation above.

- type: textarea
id: question
attributes:
label: 您的問題 / Your Question
description: 請清楚描述您的問題 / Please describe your question clearly
placeholder: 我想了解...
validations:
required: true

- type: dropdown
id: topic
attributes:
label: 相關主題 / Related Topic
description: 這個問題屬於哪個主題? / Which topic is this question about?
options:
- 🔢 數學基礎 (Math Fundamentals)
- 🐍 Python 基礎 (Python Basics)
- 🤖 機器學習 (Machine Learning)
- 🧠 深度學習 (Deep Learning)
- 🔤 LLM 基礎 (LLM Fundamentals)
- 📚 RAG 系統 (RAG System)
- 🤝 Agent 開發 (Agent Development)
- ⚙️ 環境設置 (Environment Setup)
- 📦 依賴/安裝 (Dependencies/Installation)
- 其他 (Other)
validations:
required: true

- type: textarea
id: tried
attributes:
label: 已嘗試的方法 / What have you tried?
description: 您已經嘗試過什麼方法? / What solutions have you already tried?
placeholder: 我已經嘗試...
validations:
required: false

- type: textarea
id: context
attributes:
label: 補充資訊 / Additional Context
description: 任何有助於回答問題的資訊 / Any information that might help answer your question
placeholder: 環境資訊、錯誤訊息、截圖等...
validations:
required: false
70 changes: 70 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
## 📋 PR 描述 / Description

<!-- 請簡要描述這個 PR 的目的和改動內容 -->
<!-- Please briefly describe the purpose and changes of this PR -->



## 🔗 相關 Issue / Related Issues

<!-- 如果有相關的 Issue,請在此連結 -->
<!-- Link any related issues here -->

- Closes #
- Related to #

## 🔄 改動類型 / Type of Change

<!-- 請勾選適用的選項 / Please check the applicable options -->

- [ ] 🐛 Bug 修復 / Bug fix
- [ ] ✨ 新功能 / New feature
- [ ] 📚 文檔更新 / Documentation update
- [ ] 🧪 測試相關 / Test related
- [ ] 🔧 配置/工具更新 / Configuration/Tool update
- [ ] ♻️ 代碼重構 / Code refactoring
- [ ] 🎨 代碼風格/格式 / Code style/formatting

## 📝 改動說明 / Changes Made

<!-- 詳細說明您做了哪些改動 -->
<!-- Describe what changes you made in detail -->

1.
2.
3.

## 🧪 測試方式 / How Has This Been Tested?

<!-- 描述您如何測試這些改動 -->
<!-- Describe how you tested these changes -->

- [ ] 單元測試 / Unit tests
- [ ] 手動測試 / Manual testing
- [ ] 本地運行 / Local execution
- [ ] 其他 / Other:

## 📸 截圖 / Screenshots (如適用 / if applicable)

<!-- 如果有 UI 改動,請附上截圖 -->
<!-- If there are UI changes, please attach screenshots -->



## ✅ 自我檢查清單 / Checklist

<!-- 請確認以下項目 / Please confirm the following items -->

- [ ] 我已閱讀 [CONTRIBUTING.md](../CONTRIBUTING.md)
- [ ] 我的代碼遵循專案的代碼風格
- [ ] 我已對代碼進行自我審查
- [ ] 我已添加必要的註釋(特別是複雜的邏輯)
- [ ] 我的改動不會產生新的警告
- [ ] 我已添加相關測試(如適用)
- [ ] 所有現有測試都通過

## 📌 其他備註 / Additional Notes

<!-- 任何其他需要審查者知道的事項 -->
<!-- Any other information reviewers should know -->

16 changes: 7 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,15 @@ jobs:
- name: 🔍 Ruff - 代碼檢查
run: |
ruff check . --output-format=github
continue-on-error: true

- name: 🎨 Black - 代碼格式檢查
run: |
black --check --diff .
continue-on-error: true

- name: 📝 MyPy - 類型檢查
run: |
mypy . --ignore-missing-imports --no-strict-optional
continue-on-error: true
continue-on-error: true # 類型檢查可以較寬鬆

# ==================== 單元測試 ====================
test:
Expand Down Expand Up @@ -153,18 +151,18 @@ jobs:

- name: 🔐 Bandit - 安全漏洞掃描
run: |
bandit -r . -f json -o bandit-report.json || true
continue-on-error: true
bandit -r . -f json -o bandit-report.json --exit-zero
# 產出報告但不阻擋 CI,讓開發者檢視結果

- name: 🛡️ Safety - 依賴安全檢查
run: |
safety check --json || true
continue-on-error: true
safety check --json --continue-on-error || true
# 依賴安全問題需要人工評估

- name: 🔍 Pip Audit - 依賴審計
run: |
pip-audit --desc || true
continue-on-error: true
pip-audit --desc
continue-on-error: true # 依賴審計供參考

# ==================== 構建檢查 ====================
build:
Expand Down
50 changes: 50 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 貢獻者公約 / Contributor Covenant Code of Conduct

## 我們的承諾 / Our Pledge

為了營造一個開放且友善的環境,我們作為貢獻者和維護者承諾:無論年齡、體型、殘疾、種族、性別特徵、性別認同和表達、經驗水平、教育程度、社會經濟地位、國籍、個人外表、種族、宗教或性認同和取向如何,參與我們專案和社區的每個人都不會受到騷擾。

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## 我們的標準 / Our Standards

### 有助於創造正面環境的行為 / Positive behavior:

- 使用友善和包容的語言 / Using welcoming and inclusive language
- 尊重不同的觀點和經驗 / Being respectful of differing viewpoints and experiences
- 優雅地接受建設性批評 / Gracefully accepting constructive criticism
- 專注於對社區最有利的事情 / Focusing on what is best for the community
- 對其他社區成員表示同理心 / Showing empathy towards other community members

### 不可接受的行為 / Unacceptable behavior:

- 使用性化的語言或圖像,以及不受歡迎的性關注或挑逗
- 挑釁、侮辱性/貶損性評論,以及人身或政治攻擊
- 公開或私下騷擾
- 未經明確許可,發布他人的私人資訊
- 其他在專業環境中被合理認為不適當的行為

## 我們的責任 / Our Responsibilities

專案維護者有責任澄清可接受行為的標準,並預期會對任何不可接受的行為採取適當和公平的糾正措施。

專案維護者有權利和責任刪除、編輯或拒絕與本行為準則不一致的評論、提交、代碼、Wiki 編輯、Issue 和其他貢獻,並暫時或永久禁止任何貢獻者從事他們認為不適當、威脅、冒犯或有害的行為。

## 適用範圍 / Scope

本行為準則適用於所有專案空間,也適用於個人在公共場所代表專案或其社區時。代表專案或社區的示例包括使用官方專案電子郵件地址、通過官方社交媒體帳戶發布,或在線上或線下活動中擔任指定代表。

## 執行 / Enforcement

可以通過 [建立 Issue](https://github.com/markl-a/My-AI-Learning-Notes/issues) 報告濫用、騷擾或其他不可接受的行為。所有投訴都將被審查和調查,並將產生被認為必要且適合情況的回應。專案團隊有義務對事件報告者保密。

## 歸屬 / Attribution

本行為準則改編自 [Contributor Covenant](https://www.contributor-covenant.org),版本 2.1,可在以下網址獲取:
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

---

**感謝您幫助我們建立一個友善的學習社區!**

**Thank you for helping us build a welcoming learning community!**
Loading
Loading