-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathCONTRIBUTING.md.tpl
86 lines (52 loc) · 2.1 KB
/
CONTRIBUTING.md.tpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# リポジトリ運用ガイドライン
プロジェクトに参加していただきありがとうございます。
このリポジトリを運用するにあたり、以下の項目をご確認いただけると幸いです。
## Issue
- Issueの追加は、同様のものがないか確認してからお願いします。
- 1つのIssueには1つのタスクのみを含めるようにしてください。
- `help wanted` や `high priority` のラベルがついたIssueを優先していただけると幸いです。
- このリポジトリにまだ慣れていない方は、`good first issue` のラベルがついたIssueから対応することをおすすめします。
- `pending` のラベルがついたIssueは保留中なので、実装は避けてください。
## Pull Request
- Issueへのリンクを記入するようお願いいたします。
- テストが通ることを確認してから Pull Request を作成してください。
- 見た目の変更がある場合はスクリーンショットを貼るようお願いいたします。
- 対応方法が不明な場合はIssueで相談してください。
- サポートが必要な場合は Draft Pull Request かIssueで相談してください。
## 開発環境構築手順
開発環境構築手順を記載します。
### 依存関係
依存関係を記載します。
- [tool1](#)
- [tool2](#)
### コマンド
コマンドを記載します。
```sh
# 依存ライブラリのインストール
foo install
# デバッグビルド
foo dev
# 本番ビルド
foo build
# テスト
foo test
```
## 開発フロー
開発フローを記載します。
1. foo
2. bar
3. baz
### 主なブランチ
主なブランチとその役割を記載します。
### ルール
ルールを記載します。
- レビュアー
- マージ条件
- レビューコメント
- その他
## 参考情報
- [開発者向けドキュメント](doc/dev/)
- [プロジェクト情報](../sample_project/)
- [本番環境](https://example.com)
- [ステージング環境](https://stg.example.com)
- [開発環境](https://dev.example.com)