ページ編集

プルリクエストの送信

このガイドは、Sailsフレームワークへの貢献を始めるためのものです。Githubの基本的な知識があることを前提としていますが、あらゆるレベルの貢献者にとって役立つはずです。

貢献ガイドライン

他のオープンソースプロジェクトと同様に、コードの品質を保護し、フレームワークが堅牢で信頼できる状態を保つために、貢献に関するガイドラインが必要です。そのため、バグ修正であれ、新しい機能一式であれ、Sailsへのすべての貢献において、貢献プロトコルに従うことが重要です。

プルリクエストを送信する前に、以下を確認してください。

• 可能な場合は、バグ修正にはテストが伴っていること。テストにはMochaを使用しています。
• コードは一貫性を維持するために、スタイルガイドに従っていること（リポジトリ内の.jshintや.editorconfigファイルを参照）。

現在デプロイされているバージョンに対する優先度の高いホットフィックスがある場合は、Githubでissueを投稿し、@mikermcneilにメンションしてください。また、緊急の場合は、@sailsjsまでお気軽にツイートしてください。

これで全員が同じ認識を持てたので、自分たちの素晴らしいコードを書き始めましょう :D

フォーク

まず、リポジトリをフォークします。

クローン

次に、フォークしたリポジトリをローカルファイルシステムにクローンします。 `git clone `[email protected]:YOUR_USER_NAME/sails.git`

更新

最近の変更をフォークにマージするには、プロジェクトディレクトリ内で以下を実行します。

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

詳細については、Githubを参照してください。

コード

機能強化、バグ修正など、自分のやりたいことを実行します。

テスト

追加/修正にはテストを書いてください。慣れていないと面倒かもしれませんが、これが優れたコードを維持する方法です。テストスイートには、Mochaを使用しています。テストはnpm testで実行できます。詳細については、貢献ガイドの「テスト」セクションを参照してください。

プルリクエスト

完了したら、修正をコミットし、変更をプッシュしてから、Githubにアクセスしてプルリクエストを送信できます。こちらで確認し、できるだけ早く返信します。

フォークしたリポジトリをアプリケーションで実行する

Sailsをフォークし、フォークしたSailsに対してSailsアプリをテストしたい場合は、次の手順を実行します。

フォークしたSailsのローカルコピーで: sudo npm link

Sailsアプリのリポジトリで: npm link sails

これにより、ローカル依存関係として（アプリのnode_modulesフォルダに）シンボリックリンクが作成されます。これにより、linkedしたSailsのバージョンでアプリを実行できます。

$ sails lift

ご貢献ありがとうございます！