ページ編集

Issueへの貢献

このGitHub組織内のいずれかのリポジトリで新しいIssueを開いたり、既存のIssueにコメントしたりする際は、議論がSails.jsソフトウェアの具体的な技術的な問題に関連していることを確認してください。機能リクエストやアイデアは常に歓迎しますが、GitHubのIssueとして提出しないでください。提出ガイドラインについては、下記の機能リクエストを参照してください。

Sailsの使用方法に関する一般的なヘルプについては、公式Sailsドキュメントを参照してください。さらにヘルプが必要な場合は、StackOverflowで質問するか、その他の推奨されるサポート方法を参照してください。

Sailsまたはその依存関係のセキュリティ脆弱性を見つけた場合は、公開のIssueで報告しないでください。代わりに、Sailsセキュリティポリシーに記載されている手順を使用して、コアメンテナーにすぐに警告してください。Sails.jsコアチームが直接メンテナンスしていない外部の依存関係（例：Socket.io、Express、Node.js、またはopenssl）についても、このリクエストに従ってください（コアチームが問題を修正できると信じているかどうかにかかわらず、セキュリティポリシーの手順に従って、脆弱性をできるだけ早く非公開で開示してください）。

最後に、チームメンバーシップ、商標、行動規範、プロジェクトに関する上位レベルの質問や懸念など、非技術的な性質の議論は、[email protected]にメールで直接コアメンテナーに送信してください。

Issueのオープン

Sailsは多くの異なるサブプロジェクトで構成されており、その多くは独自の専用リポジトリを持っています。それでも、Sailsコアチームがメンテナンスするモジュールで疑わしいIssueを提出するのに最適な場所は、メインのSailsリポジトリです。これにより、Issueを把握し、整理することができます。

Issueを提出する前に、これらの簡単な手順に従ってください。

まず、メインのSailsリポジトリ内でGitHub検索を使用して、あなたと同様のIssueを検索してください。

元のバグレポートが既存のオープンIssueでカバーされている場合は、新しいIssueを開く代わりに、そのIssueにコメントを追加してください。
すべての関連するIssueがクローズされている場合は、新しいIssueを開き、既にクローズされているIssueのURLへのリンクを下に貼り付けてください。
関連するIssueが見つからない場合は、必要に応じて異なる検索キーワードを使用してみてください（検索方法に影響を与える場合、執筆時点ではGitHubはLuceneをベースにしたElasticSearchを使用してコンテンツをインデックスしています）。それでも関連する既存のIssueが見つからない場合は、新しいIssueを作成してください。
バックリンクの重要性を考慮してください。あなたのIssueに対応する貢献者は、ほぼ必ず自分自身で同様の既存のIssueを検索する必要があるため、すべてのURLを1か所にまとめることは非常に時間の節約になります。また、新しいIssueからのバックリンクにより、GitHubは参照元のIssueに新しいIssueのURLへのリンクを自動的に挿入します。これは、多くのGitHub Issueの訪問者が検索エンジンから来ているため、非常に役立ちます。

新しいIssueを作成する必要があると判断したら、

新しいIssueが複数の無関係な問題を報告していないことを確認してください。
- 複数の問題が発生していて、それらの問題が明らかに別個のものである場合は、それぞれに個別のIssueを作成しますが、最も緊急性の高いものから始めましょう。
- 複数の関連する問題（同時にしか再現できない問題）が発生している場合は、1つのIssueのみを作成してください。ただし、両方の問題を徹底的に説明し、両方の問題が発生する手順についても説明するようにしてください。
Issueには、利用可能なスペースで問題をできる限り分かりやすく説明する、簡潔で適切なタイトルを使用していることを確認してください。理想的なIssueタイトルは、問題を一目で伝えるものです。
- たとえば、「jst.js being removed from layout.ejs on lift」は、Issueにとって非常に役立つタイトルです。
- 以下は役に立たないIssueタイトルの例です。
  - 「templates dont work」: このタイトルは曖昧すぎます。さらに情報を得ることができない場合でも、「unexpected behavior with templates」のような表現の方が具体的で、より迅速な対応が期待できます。
  - 「app broken cannot access templates on filesystem because it is broken in the asset pipeline please help」: このタイトルは冗長で、不要なコンテンツ（「please help」）が含まれています。役立つタイトルは、記述的で簡潔なものであることを忘れないでください。
  - 「jst.js is being REMOVED!!!!!!!!!"」: このタイトルには、不要な大文字と句読点が含まれており、せいぜい気が散るものであり、失礼と見なされる可能性があります。いずれの場合も、Issueへの対応を早める可能性は低いです。
  - 「How does this dumb, useless framework remove jst.js from my app?」: このタイトルには不要な否定的な言葉が含まれており、参加者のレビューを促しません。可能な限り客観的なタイトルを維持して、最高のIssue解決エクスペリエンスを得るようにしてください。
  - 「Thousands of files being corrupted in our currently deployed production app every time the server crashes.」: このような言葉は誇張されていると見なされ、主張の信頼性を低下させる可能性があります。この場合、Issueを混乱させることさえあります（例：「これはNODE_ENV===productionの場合にのみ発生していますか？」）。
Issueを再現する手順をまとめる前に、個人開発環境の変数をできるだけ標準化してください。
- 適切なアプリが起動されていることを確認してください。
- CTRL+CでSailsサーバーを終了し、再度起動したことを確認してください。
- localhostをポイントした開いているブラウザタブがないことを確認してください。
- 他のターミナルウィンドウで他のSailsアプリが実行されていないことを確認してください。
- Issueの再現に使用しているアプリのnode_modules/ディレクトリがクリーンであることを確認してください。つまり、
  - 依存関係がリンクされていない（例：npm link fooを実行していない）
  - node_modules/フォルダ内のファイルにインライン変更を加えていない
  - 奇妙なグローバル依存関係ループがない上記のいずれかについて確信が持てない場合は、rm -rf node_modules && npm cache clear && npm installを実行するのが最も簡単な方法です。
アプリで使用しているSailsのバージョン（sails -v）を指定してください。
- これは、グローバルにインストールされているSailsのバージョンとは異なる場合があります。
現在インストールされているNode.jsのバージョン（node -v）、NPMのバージョン（npm -v）、および実行しているオペレーティングシステム（OS X、Windows、Ubuntuなど）を指定してください。
- nvmまたはnなどのNodeバージョンマネージャーを使用している場合は、Issueで必ずそれを明記してください。
クリーンなSailsアプリ（つまり、特別な環境変数や.sailsrcファイルのないコンピューターでsails newを使用して作成されたアプリ）から問題を再現するための詳細な手順を記載してください。
最後に、投稿しようとしている内容とその内容が他のSailsユーザーベースによってどのように解釈されるかを少し考えてみましょう。行動規範に沿っていることを確認し、セキュリティの脆弱性を公開して他のSailsユーザーを危険にさらしていないことを確認してください。

これらのガイドラインを満たしていないIssueは、通常、読まれることなくクローズされ、提出者にこの貢献ガイドを見直すように求める返信が返されます。このようなことが発生した場合は、個人的な問題ではないことを理解してください。そして、再び起こる可能性があることにも理解してください。Sailsは、毎月何百もの新しいIssueの提出を受け取る大規模なプロジェクトであり、詳細なIssueを投稿するために寄付してくれた時間には本当に感謝しています。この貢献ガイドに記載されている規則や基本ルールに慣れてくると、将来の貢献がコミュニティにとってより役立つようになります。また、コアチームメンバーからの尊敬を得て、将来の貢献者にとって良い模範となります。