Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.85 KB

Contribution Guide

このプロジェクトに貢献したいと思ってくださり、ありがとうございます。

議論について

以下の場所で議論をしています。

Issue

バグ報告・欲しいライブラリ・機能追加など、歓迎しています。 新しい Issue を作る

Pull Request

以下のような pull request を歓迎しています。

  • 新しいアルゴリズムの追加
  • 新しいテストの追加
  • 既存のライブラリ・テストコードのバグ修正・改善
  • ドキュメントの加筆・修正

Pull request を送るべきか迷った場合は、 issue を立てて相談してみてください。 実際に開発を行う際には、wiki の開発の流れを参考にしてください。

Pull Request を送っていただく前に

ローカルで以下のことが成り立つかどうか確かめてください:

  • ライブラリ用のコード本体は src/ 以下に、テスト用のコードは test/ 以下にある
  • ./travis-test.sh を実行して OK という文字列が表示される

./travis-test.sh は内部で clang-format を実行するため、あらかじめインストールしておく必要があります。(開発環境)