貢獻指南

感謝你願意為 ok-star-resonance 做貢獻。提交修改前，請先閱讀首頁的免責宣告並確保專案能從原始碼執行。

開發約定

• 僅使用 Python 3.12。
• requirements.in 是直接依賴的唯一來源；修改後使用 uv pip compile 生成 requirements.txt。
• 持續任務繼承 SRTriggerTask，一次性任務繼承 SRTask，並在 src/config.py 註冊。
• OCR 文本應覆蓋適用的簡中、繁中、英文與日文客戶端。
• 遊戲座標優先使用相對畫面的 0–1 比例，不直接硬編碼畫素座標。
• 長迴圈使用框架提供的可中斷等待方法，並確保異常路徑釋放按鍵和滑鼠。
• 不要實現讀取遊戲記憶體、修改遊戲檔案或注入遊戲程序的功能。

編寫任務時優先參考 ok-script API 文件。

提交 PR 前

1. 保持改動範圍清晰，不混入無關格式化或重構。
2. 執行與改動相關的測試，並在 PR 描述中寫明結果。
3. 使用者可見行為發生變化時，提供截圖、錄屏或清晰的復現步驟。
4. 不要提交日誌、截圖、快取、個人配置、真實抓包或其他敏感資料。
5. 修改 protobuf 時同時提交 .proto 和生成的 _pb2.py，並執行解析器測試。

文件貢獻

文件原始檔位於 docs/，導航與主題配置位於倉庫根目錄的 mkdocs.yml。新增頁面後請同步更新 nav，並執行：

.\.venv\Scripts\python.exe -m mkdocs build --strict

嚴格構建會把無效連結、遺漏導航等問題作為錯誤報告。