11# Relaym Server
2- RelaymのサーバーサイドAPIを管理するリポジトリです。
2+
3+ Relaym のサーバーサイド API を管理するリポジトリです。
34
45![ test_and_lint] ( https://github.com/camphor-/relaym-server/workflows/test_and_lint/badge.svg )
56[ ![ codecov] ( https://codecov.io/gh/camphor-/relaym-server/branch/master/graph/badge.svg )] ( https://codecov.io/gh/camphor-/relaym-server )
67
7- API仕様は [ こちら] ( docs/api.md )
8+ API 仕様は [ こちら] ( docs/api.md )
89
910## 開発に参加するには?
1011
11121 . [ CAMPHOR- Code of Conduct] ( https://github.com/camphor-/code-of-conduct ) に同意してください。
12131 . [ CAMPHOR- Lab] ( https://lab.camph.net/ ) に参加しましょう!
1314
14-
1515## 開発を始める前に
1616
1717### STEP1 サービス内容を理解する
@@ -23,20 +23,19 @@ API仕様は[こちら](docs/api.md)
2323
2424### STEP2 アーキテクチャを理解する
2525
26- APIリクエストはHTTPで受け付けています 。曲の操作に[ Spotify Web API] ( https://developer.spotify.com/documentation/web-api/ ) を使用しています。
26+ API リクエストは HTTP で受け付けています 。曲の操作に[ Spotify Web API] ( https://developer.spotify.com/documentation/web-api/ ) を使用しています。
2727
2828詳しくは [ docs/architecture.md] ( docs/architecture.md ) をご覧ください。
2929
3030### STEP3 データベースの設計を理解する
3131
32- RelaymではMySQLをデータベースとして採用しています 。
32+ Relaym では MySQL をデータベースとして採用しています 。
3333
3434詳しくは [ docs/database.md] ( docs/database.md ) をご覧ください。
3535
36-
3736### STEP4 アプリケーションアーキテクチャを理解する
3837
39- DDDやClean Architectureライクなアーキテクチャを採用しています 。
38+ DDD や Clean Architecture ライクなアーキテクチャを採用しています 。
4039
4140詳しくは [ docs/application_architecture.md] ( docs/application_architecture.md ) をご覧ください。
4241
@@ -48,18 +47,18 @@ DDDやClean Architectureライクなアーキテクチャを採用していま
4847
4948### 一般的な開発ルール
5049
51- - GitHub Flowを用いたブランチ管理を行います 。
52- - 設計はGitHub Issueを使って行います 。
53- - 新規機能の場合は必ずIssueを立てます 。
54- - ** PR, Issue, Commit, Commentは全て日本語を可とします 。**
50+ - GitHub Flow を用いたブランチ管理を行います 。
51+ - 設計は GitHub Issue を使って行います 。
52+ - 新規機能の場合は必ず Issue を立てます 。
53+ - ** PR, Issue, Commit, Comment は全て日本語を可とします 。**
5554
5655### レビュー
5756
58- PRのマージにはレビュワーのApproveを必要とします 。
57+ PR のマージにはレビュワーの Approve を必要とします 。
5958
6059レビューで確認すべき一般的な事項は[ Google エンジニアリング・プラクティス ドキュメント] ( http://shuuji3.xyz/eng-practices/ ) に従います。
6160
62- Goに関する作法は以下のドキュメントに従います 。
61+ Go に関する作法は以下のドキュメントに従います 。
6362
6463- [ Go Codereview Comments] ( https://knsh14.github.io/translations/go-codereview-comments/ )
6564- [ Effective Go] ( https://golang.org/doc/effective_go.html )
0 commit comments