Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
コントリビュートをしてくださる方に向けた文書をリポジトリーに追加する。 簡単な環境構築の方法を書いたり、IssueやPull Requestを作る際の指針について書いている。 ほかにも必要そうな項目があれば、そのつど追加していきたい。
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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を作るような形でも問題ありません。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters