編輯頁面

發送 Pull Request (提取請求)

本指南旨在協助您開始為 Sails 框架做出貢獻。它假設您對 Github 有基本認識，但對於所有程度的貢獻者都應該有所幫助。

貢獻指南

如同任何開源專案，我們必須制定貢獻指南——這有助於保護程式碼品質，並確保我們的框架保持穩健可靠。基於這些原因，無論是錯誤修復還是整套新功能，所有對 Sails 的貢獻都必須遵循貢獻協議，這一點非常重要。

在提交 Pull Request 之前，請確保

• 任何錯誤修復都應盡可能附帶測試。我們使用 Mocha 進行測試。
• 程式碼應遵循我們的樣式指南，以保持一致性（請參閱 repo 中的 .jshint 和/或 .editorconfig 檔案）。

如果您有針對目前已部署版本的高優先級熱修復，請在 Github 上發布 issue 並提及 @mikermcneil。此外，若遇緊急情況，請隨時發推文給 @sailsjs。

既然我們都達成共識了，就讓我們開始編寫一些屬於我們自己的精彩程式碼吧 :D

Fork

首先 fork 儲存庫

Clone

然後將您的 fork 複製到您的本機檔案系統：git clone `[email protected]:YOUR_USER_NAME/sails.git`

更新

若要將最近的變更合併到您的 fork 中，請在您的專案目錄內

git remote add core https://github.com/balderdashy/sails.git
git fetch core
git merge core/master

如需更多詳細資訊，請參閱 Github。

程式碼

進行您的增強功能、修復錯誤，盡情發揮。

測試

請為您的新增功能/修復編寫測試。我知道如果您不習慣可能會覺得有點麻煩，但這是我們維持優良程式碼的方式。對於我們的測試套件，我們使用 Mocha。您可以使用 npm test 執行測試。如需更多資訊，請參閱貢獻指南中的「測試」章節。

Pull Request (提取請求)

完成後，您可以提交您的修復、推送您的變更，然後進入 Github 並提交 Pull Request。我們會盡快審閱並回覆您。

在您的應用程式中使用您的 fork 執行

如果您 fork 了 Sails 並且想要針對您的 fork 測試您的 Sails 應用程式，以下是如何操作

在您 Sails fork 的本機副本中：sudo npm link

在您的 Sails 應用程式的 repo 中：npm link sails

這會建立一個符號連結作為本機依賴項（在您應用程式的 node_modules 資料夾中）。這會讓您可以使用您 linked 的 Sails 版本執行您的應用程式。

$ sails lift

感謝您的貢獻！