開発者向け情報

バグ報告と機能のリクエスト

Kobin に関する問題に遭遇したり、新機能に対するアイデアがある場合は、Github上の issue tracker に提出してください。

関係するソースファイルを含めるか、リンクを提供することで、私たちが問題を解決する助けになります。可能なら、エラーを生成する最小のプロジェクトを作成して、代わりにそれを送信するようにしてください。

ドキュメント

ビルド

  • 英語: make html

  • 日本語: make -e SPHINXOPTS="-D language='ja'" html

翻訳

po ファイルをアップデートしてください。

$ make gettext
$ sphinx-intl update -p build/locale
# edit doc/source/locale/*.po files
$ make -e SPHINXOPTS="-D language='ja'" html

ref: 国際化 – Sphinx documentation

テスト

Kobinプロジェクトでは以下の項目をテストしています。もし変更を加えた場合、toxコマンドを実行してチェックしてください。

  • test: python setup.py test
  • coverage: coverage run setup.py test && coverage report
  • mypy: mypy --check-untyped-defs --fast-parser --python-version 3.6 kobin
  • Flake8: flake8
  • doctest: cd docs; make doctest
  • Run all with tox: tox