Blender Sverchok Contributing small thingsドキュメントを読む

はじめに

ノードのカスタマイズがしたくなったので関連するっぽいドキュメントを読んでみます

参照元

nortikin/sverchok
Sverchok. Contribute to nortikin/sverchok development by creating an account on GitHub.

Contributing small things

これを読んでいるならあなたはSverchokの変更や追加を行いたいと思っているのでしょう。それはいいことです。もしそうでないなら、このドキュメントは読まなくても大丈夫です。

これを読む時間を取っていただいてありがとうございます。私たちはコードやドキュメントへの貢献を喜んで受け入れます。私たちは、Sverchok全体の理解に照らして、提案された変更点を常に検討していきます。Sverchokのコードは大きく、理解するのが難しい部分もあります。もしあなたの提案を受け入れるべきでないと考えた場合我々の立場を守ります。通常はSverchokにとって理解できる点で折り合いを付けていきます。

Pullリクエスト

全てのPullリクエストはSverchokに対し”正式に提案された変更”と考えることができます。あなたはGithubにより提供されているオンラインGitツールを介す、またはGITを介してこれを行うことができます。gitについての初心者の方は小さな変更に関してGithubカニズムを使ったほうが良いでしょう。Githubガイドラインを見てくださいhttps://help.github.com/articles/about-pull-requests/

非公式コードの提案

もしあなたがgitやgithubインタフェースを通したくない場合は、issueトラッカーに変更内容書いて提案することもできます。issueを開き、タイトルに希望や提案内容を簡潔に書いてください。issueではMarkdownが使えます。コードのセクションではあなたが考えていることや有益な変更内容、なぜ変更するかなどを書いてください。Permalinkを含めることも可能です。

そして、その下には次のように”差分”を書きます。

In the following file: sverchok/nodes/scene/frame_info.py on line 122
 

diff
- print(some_variable)
+ # print(some_variable)

this node prints very often, and seems to slow down Blender because of it.
I’m not certain but I don’t think this printout it essential and suggest you drop it.

と diff (言語タイプ) を使用すると、以下のように構文を強調してコードの変更案を表示します。

- print(some_variable)
+ # print(some_variable)

このようにして、どのコードについて話しているのか、何を変更するのか、そしてその理由を示すことができます。明確なissueを我々は好みます。

1行ではない変更

時には2行以上のときもあります。”小さな貢献(small contributing)”というのは定義が難しくなり、正確でもなくなっていくでしょう。そのようなときでも我々はコードを見て理解します。コードブロックの編集も関数の置き換えも受け付けます。多くの変更を行いたい場合は、我々はよりプロファイルやパフォーマンスといった論拠を求めるでしょう。

何が私たちの注意を引くのか

すべてです。あなたのコード提案が既存のコードの本当の欠陥を修正し、問題となっている領域の外であまり多くの変更を必要としない場合、私たちはより寛大/迅速になる傾向があります。

一般的なガイドライン

寄与されたコードがどのように見え、どのように動作するかを知るために読むべきドキュメントはこちら ( contribute.rst ) です。

コメント

タイトルとURLをコピーしました