🙌 Postar 開源貢獻指南

感謝您對本專案的關注！我們歡迎所有形式的貢獻，包括報告問題、提交錯誤修復、提出新功能等。為確保專案的健康發展，請在貢獻前閱讀並遵循以下指南。

開始

複製專案到本地：

bash

git clone https://github.com/gitcoffee-os/postar.git

安裝依賴 根據專案的需要安裝所需的依賴。通常可以在專案的 README 檔案中找到安裝說明。
建立新分支 在開始工作之前，確保從最新的 main 或 master 分支拉取程式碼，並為您要處理的問題或功能建立一個新分支：
bash
```
git checkout -b <feature-branch-name>
```

報告問題

如果您發現問題或有建議，請按照以下步驟報告：

在 GitHub 的 Issues 頁面建立新的 issue。
詳細描述問題，包括重現步驟、錯誤資訊、截圖以及任何可能有助於解決問題的資訊。

提交程式碼

分支管理

進行任何變更時，始終從最新的 main 或 master 分支建立新分支，並將您的工作提交到該分支。

提交資訊規範

我們遵循 Conventional Commits 規範來格式化提交資訊。確保每條提交資訊簡潔明瞭，並遵循以下格式：

<type>(<scope>): <description>

範例：

feat(publisher): 新增 Medium 平臺發布支援
fix(content): 修復內容擷取時圖片遺失的問題
docs: 更新文件中的 API 使用範例

常見類型：

feat：新功能
fix：錯誤修復
docs：僅文件
style：程式碼格式化（無功能變更）
refactor：程式碼重構
test：新增或更新測試
chore：雜項（如建置過程或依賴管理）

程式碼風格

本專案使用 Prettier 和 ESLint 來強制執行程式碼風格。在提交程式碼之前，確保程式碼已經自動格式化並透過靜態檢查。如果您沒有安裝這些工具，請按照以下步驟操作：

安裝依賴：
bash
```
pnpm i
```
執行程式碼格式化：
bash
```
pnpm run format
pnpm run format:check
```

測試

我們鼓勵編寫測試以確保程式碼品質並防止回歸。在提交程式碼之前，確保所有測試透過。

新增測試 如果您的變更涉及功能或錯誤修復，請為該部分新增新的單元測試，並確保測試覆蓋所有相關場景。
執行測試 執行專案的測試套件以確保所有測試透過。
bash
```
pnpm test
```

程式碼審查

每次提交都透過 Pull Request (PR) 進行審查。我們歡迎任何人參與審查過程。審查時，請遵循以下幾點：

檢查功能：確保程式碼解決了問題或實現了預期功能。
檢查程式碼品質：確保程式碼易於閱讀和理解，並遵循專案的編碼標準。
檢查測試覆蓋：確保功能變更沒有導致測試失敗；如有必要，編寫新測試。

授權條款

本專案基於 Apache License 2.0 授權。詳見 LICENSE 檔案。

感謝您為本專案貢獻！如果您有任何問題或建議，請隨時提出——我們將盡力幫助您。

🙌 Postar 開源貢獻指南 ​

目錄 ​

開始 ​

報告問題 ​

提交程式碼 ​

分支管理 ​

提交資訊規範 ​

程式碼風格 ​

測試 ​

程式碼審查 ​

授權條款 ​