Skip to content

Commit

Permalink
Add CONTRIBUTING.md Close #85
Browse files Browse the repository at this point in the history
コントリビュートをしてくださる方に向けた文書をリポジトリーに追加する。

簡単な環境構築の方法を書いたり、IssueやPull Requestを作る際の指針について書いている。
ほかにも必要そうな項目があれば、そのつど追加していきたい。
  • Loading branch information
ykzts committed Mar 1, 2017
1 parent 767a181 commit 7bb412d
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,39 @@
# Contributing

BaberuTVでは不具合の報告や機能要望は常に歓迎しています。

[Issues](https://github.com/baberutv/baberutv/issues)に重複するものがないかを確認した上でIssueの作成をしてください。開発の進行状況については[Projects](https://github.com/baberutv/baberutv/projects/1)で管理しています。あわせてご確認ください。

## 開発環境構築

開発環境の構築には[Docker Compose](https://docs.docker.com/compose/)を使うことを強く推奨します。[Docker](https://www.docker.com/)とDocker Composeがインストールされていれば、あとはインターネット環境さえあれば既存の環境に大きな影響を与えずに開発環境の構築が行えます。

```shell
$ docker-compose up
```

というコマンドを実行すると`8080`版ポートで[`webpack-dev-server`](https://webpack.js.org/configuration/dev-server/)が起動します。

`webpack-dev-server`が起動している状態でコードに変更を加えると、変更が反映された上でウェブブラウザーで開かれている場合は、そちらでも自動的に更新がされます。

## コードフォーマット

コードのフォーマットの確認には[ESLint](http://eslint.org/)を使っています。

```shell
$ docker-compose run webpack yarn lint
```

というコマンドを実行することによって、コードフォーマットに正しく従えているかどうかを確認できます。

## テスト

```shell
$ docker-compose run webpack yarn test-only
```

というコマンドを実行することによって自動テストが実行されます。テスト自体は[`./__tests__`](/__tests__)以下にありますが、現時点ではほとんど書かれていません。今後充実させていくというのが課題となっています。

## Pull Request

[Pull Request](https://github.com/baberutv/baberutv/pulls)についてはあらかじめIssueの作成を行ってからにしてもらえると助かります。これは作業の無用な競合が起こってしまわないようにしたいためです。ただし小さな誤入力などの修正といった細かな修正についてはわざわざIssueを作らずに直接Pull Requestを作るような形でも問題ありません。
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -2,6 +2,8 @@

BaberuTVはTVです。TVとはつまりTelevisionの略です。つまり遠隔の映像を受信して流す機器を指します。BaberuTVではウェブブラウザーを用いて、どのような環境からでも別の場所に存在する動画の再生を行えるアプリケーションです。

不具合の報告や機能要望がありましたら、[Code of Conduct](/CODE_OF_CONDUCT.md)を読んだ上で(CONTRIBUTING.md)[/CONTRIBUTING.md]をご参照ください。

## 対応しているウェブブラウザー

- Google Chrome
Expand Down

0 comments on commit 7bb412d

Please sign in to comment.