CONTRIBUTING.md

Contributing to BlockPilot

感謝協助改善 BlockPilot。請先確認變更範圍清楚、可重現並且不會包含私人執行資料。

開發環境

npm ci
npm run setup-env

開發時分別啟動 API 與 Web：

npm run dev -w @blockpilot/api
npm run dev -w @blockpilot/web

授權

BlockPilotMC 採用 Apache License 2.0。提交程式碼、文件或其他內容，即表示你有權提供該內容，並同意依 Apache License 2.0 授權專案使用與散布。請勿提交授權不相容、來源不明或無權公開的內容。

提交前檢查

npm run verify

另外請確認：

1. 不提交 .env、金鑰、密碼、權杖、SQLite、世界存檔、備份或主控台紀錄。
2. 新增或修改的 TypeScript、JavaScript、Shell、PowerShell、CSS 與部署設定需保留用途註解。
3. 公開函式、API 路由、React 元件、跨平台工具與安全流程，需說明輸入、輸出、副作用、錯誤及設計原因；不要求每一行都加上重複註解。
4. 所有使用者可見文字必須同步維護繁中、簡中與英文。
5. 不直接修改 dist；請修改 src 後重新建置。
6. 外部下載、壓縮檔、檔案路徑、程序終止與驗證流程必須保留安全檢查。
7. 不提交內部開發操作日誌、臨時檢查筆記、個人待辦清單或只供本機使用的測試輸出。

Pull Request 建議格式

• 說明問題與修改目的。
• 列出受影響的頁面、API、資料庫或平台。
• 附上驗證方式及結果。
• 介面變更請附淺色、深色及小螢幕截圖。
• 若有相容性或升級影響，請更新 RELEASE_NOTES.md 與相關文件。

問題回報

一般錯誤可使用 Issue 範本。安全漏洞請依 SECURITY.md 私下回報。