CONTRIBUTE.md

貢献方法

cpsbot の開発に興味をもった人向けのドキュメントです。

install

このリポジトリをクローンしてから

$ cd cpsbot
$ yarn install

スクリプトの追加

scripts以下に新しいスクリプトを配置するとhubotから読み込まれます。 また、3行程度の短いスクリプトの場合は、misc.jsに追加するといいでしょう。

コミット

commit 時に何やらエラーが出るのは husky でコードが正当かチェックが走るようになっているからです。 ESLint というコード規約ツールを使っています。エラーの指示に従ってコードを修正してからpush しましょう。 もしくは、自分のコードスタイルは間違っていないという強い意志を持つ場合、 .eslintrc.js を編集するという手もあります。

デプロイ

masterにpushすればherokuへ自動デプロイされます。

コードレビューされたい人はブランチを作って master に向けてプルリクを投げるやりかたをオススメします。 その場合、masterにマージされたらもちろん自動デプロイされます。

関連

• Travis CI
  • CI ツ＝ルにTravis CI を使っています。
  • https://travis-ci.org
  • 上記URLにアクセスしてGitHubアカウント(cpslabのグループに入っている)でログインすると使えるようになる
• Heroku
  • Heroku にアプリケーションをデプロイしています。
  • https://jp.heroku.com
  • まっきーに権限くれと言ってくれればあげます(雑に頼んでok)

その他

分からないことがあればまっきーとか #dev_cpsbot に気軽に投げてください。