ドキュメント変更の提案

Symbol Developer Documentation はオープンソースプロジェクトであり、私達のコミュニティからの貢献を待っています - そう、あなたのことです!ガイドを書くこと、ドキュメントを改良すること、エラーや要求を提出すること、あるいはドキュメント自体に組み込むことができる新しいドキュメントを書くこと、多くの方法で貢献することができます。

エラーの報告

Symbol Developer Documentation で誤植を発見したと思われる場合は、まず Symbol Developer Documentation の最新バージョンに対してテストしていることを確認してください - あなたの問題は既に修正されている可能性があります。そうでない場合、同様の問題が既に開かれていないか、GitHub の issue リストを検索してください。

エラーの再現の準備をしていただけるととても助かります。問題を発見して修正するための手助けとなります。

問題の報告には次のテンプレートを使うことを考慮してください:

エラーの説明

発生したエラーについての明確で簡潔な説明。

再現方法

挙動を再現する方法:

  1. 『…』 へ移動する
  2. 『….』 をクリックする
  3. 『….』 へスクロールする
  4. エラーを確認する

意図していた挙動

期待していた挙動についての明確で簡潔な説明。

スクリーンショット

該当する場合は、問題を説明するためにスクリーンショットを追加してください。

新しい issue をここから開いてください。

要望

あなたが望んでいるコンテンツが Symbol Developer Documentation に存在しないと思っているなら、それはあなただけではないのかもしれません。現在 Symbol Developer Documentation が提供しているドキュメントやガイドの多くは、ユーザーが必要と感じたため追加されました。不足しているドキュメントや必要だと思う改善は GitHub のissueリストに issue を開いてください。

改善がドキュメントに関連するものではなく、特定のプロジェクトである場合は、プロジェクトリポジトリの CONTRIBUTING.md を確認してください。

コードやドキュメントへの貢献による変更

Symbol Developer Documentation を拡張し改善するには、先にそれに関する issue を見つけてください。そして、あなたが何をしたいかを話してください。誰かが既にそれに取り組んでいるか、変更を実装する前に知っておくべき特定の問題があるかもしれません。

私たちは貢献者と協力してプルリクエストを受け入れています。

symbol-docs のビルド

ドキュメントの変更が小さい場合は、画面の右上にある 「Edit on Github」 ボタンを使用してください。

かなりの変更もしくは貢献をする場合、 symbol-docs repository リポジトリをフォークして、あなたのマシンへクローンする必要があるかもしれません。 github help を参照してください。

はじめに Python 2.7 または 3.4+ と pip がインストールされていることを確認してください。

そして pip を使用して要求環境のインストールします:

pip install -r requirements.txt

次のコマンドを実行して提供された URL をブラウザで開きます。

make livehtml

変更の提出

あなたの変更とテストがレビューに提出する準備ができたら:

  1. あなたの変更をテスト

make livehtml を実行し、変更した部分をプレビューしてください。

  1. プルリクエストの提出

ローカルでの変更をフォークしたリポジトリのコピーにプッシュし submit a pull request を送信します。プルリクエストであなたの変更を要約するタイトルを記入し、変更が何をしているかの詳細を本文に記入します。また、議論が行われた場合の issue 番号、例えば 「Closes#123」 も記入します。

それが済んだら休憩して待ちましょう。プルリクエストについての議論をして、その変更が必要な場合はプルリクエストを symbol-docs にマージするための協力をしたいと思います。

貢献ライセンスの通知

コードを投稿すると、その投稿はオリジナルの作品であり、プロジェクトのオープンソースライセンスの下でプロジェクトにライセンス供与されているとみなします。

これを明示的に述べているかどうかにかかわらず、著作権で保護された素材をプルリクエスト、電子メール、またはその他の方法で提出することは、プロジェクトのオープンソースライセンスの下での素材のライセンスを取得することに同意し、法的権限を有することを保証します。

CONTRIBUTING.mdCONTRIBUTING-template.mdelasticsearch/CONTRIBUTINGspark/CONTRIBUTING をベースとしています。