貢献する¶
寄付は大歓迎です、そして、彼らは大いに感謝しています!少しずつ助けられ、常に信用が与えられます。
あなたはいろいろな方法で貢献することができます:
貢献の種類¶
レポートのバグ¶
バグはhttps://github.com/SekouD/potranslator/issuesで報告してください。
バグを報告している場合は、以下を含めてください:
- お使いのオペレーティングシステムの名前とバージョン。
- トラブルシューティングに役立つローカルセットアップに関する詳細。
- バグを再現するための詳細な手順。
バグ修正¶
GitHubのバグの問題を見てください。 「バグ」と「ヘルプが必要」とタグ付けされたものは誰でも、それを実装したいと思っている人には公開されています。
機能を実装する¶
機能についてはGitHubの問題を見てください。 「強化」と「援助したい」というタグが付いているものは、誰でもそれを実装したいと思う人には公開されています。
ドキュメントを書く¶
翻訳者は、公式の翻訳者ドキュメント、ドキュメントストリング、ブログ記事、記事などのウェブ上であっても、常により多くのドキュメントを使用することができます。
フィードバックを送信¶
フィードバックを送信する最善の方法は、https://github.com/SekouD/potranslator/issuesで問題を提出することです。
フィーチャーを提案している場合:
- それがどのように機能するかを詳細に説明してください。
- スコープをできるだけ狭くしておくと、実装が簡単になります。
- これはボランティア主導のプロジェクトであり、貢献は歓迎します:)
始めよう!¶
貢献する準備ができましたか?ローカル開発のために `potranslator 'を設定する方法は次のとおりです。
GitHubで `potranslator`リポジトリをフォークします。
ローカルでフォークをクローン:
$ git clone git@github.com:your_name_here/potranslator.git
ローカルコピーをvirtualenvにインストールします。 virtualenvwrapperがインストールされていると仮定すると、ローカル開発用にフォークを設定する方法です:
$ mkvirtualenv potranslator $ cd potranslator/ $ python setup.py develop
ローカル開発のためのブランチを作成する:
$ git checkout -b name-of-your-bugfix-or-feature
これで、ローカルで変更を加えることができます。
変更が終わったら、変更内容がflake8とtestingを通過していることを確認します。他のPythonのバージョンをtoxでテストすることもできます:
$ flake8 potranslator tests $ python setup.py test or py.test $ tox
flake8とtoxを取得するには、それらをvirtualenvにインストールしてください。
変更をコミットしてブランチをGitHub ::に送ります
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
GitHubのウェブサイトからプルリクエストを提出してください。
プルリクエストガイドライン¶
プルリクエストを送信する前に、次のガイドラインに従っていることを確認してください:
- プルリクエストにはテストを含める必要があります。
- プル要求が機能を追加する場合は、ドキュメントを更新する必要があります。新しい機能をドキュメントストリングを含む関数に置き、その機能をREADME.rstのリストに追加します。
- プルリクエストは、Python 2.7,3.4,3.5、および3.6、およびPyPyで動作するはずです。 https://travis-ci.org/SekouD/potranslator/pull_requestsをチェックし、テストがサポートされているすべてのPythonバージョンを通過することを確認してください。
展開¶
保守担当者にデプロイ方法のリマインダー。すべての変更がコミットされていることを確認してください(HISTORY.rstのエントリを含む)。次に実行:
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
テストが合格するとTravisはPyPIにデプロイします。