プロジェクト

全般

プロフィール

バグチケットの進め方 » 履歴 » バージョン 4

toshi_a 初音, 2018-06-30 21:15

1 4 toshi_a 初音
2
3 1 toshi_a 初音
{{>toc}}
4
5
h1. 進め方
6
7 2 toshi_a 初音
トラッカー「バグ」は、[[ロール#報告者|報告者]]がある現象をバグだと考えて報告する場合に使われる。
8 1 toshi_a 初音
9
基本的な流れとしては、
10
11 2 toshi_a 初音
# [[ロール#コミッタ|コミッタ]]が、それは仕様なのかバグなのか判断する(分類待ち)
12 1 toshi_a 初音
# バグであると判断した場合、修正パッチを募集する(実装待ち)
13
# 修正パッチを試用し、レビューする(パッチ適用待ち、レビュー待ち)
14
# 適切なブランチにmergeする(マージ待ち)
15
16
というふうになる。
17
18
h2. ステータス「分類待ち」の場合
19
20 2 toshi_a 初音
この場合、[[ロール#モデレータ|モデレータ]]がそれがバグなのか、または意図した挙動なのかを判断し返信する。
21 1 toshi_a 初音
22
意図した挙動であればその理由を説明し、ステータスを「却下」に変更する。
23 2 toshi_a 初音
[[ロール#モデレータ|モデレータ]]が実際にバグであると判断すれば、以下の条件に従って次に進める。
24 1 toshi_a 初音
25
h3. 別にバグじゃない場合
26
27
明らかに見当違いであったり、議論の末報告された問題はバグではなく、修正する必要がないと判断した場合はステータスを「却下」にする。
28
29
他にも、以下のような場合は「却下」となる。
30
31
* Twitter関連のバグだったが、TwitterがAPIの提供を止めたなど、修正する意味が無くなった
32
* 提案には一理あるが、プログラムではなく当初の考え方に問題があり、どちらかといえば機能追加となってしまう場合(この場合はトラッカーを「機能」に変えることもある)
33 2 toshi_a 初音
* [[ロール#報告者|報告者]]以外誰も再現できておらず、その後[[ロール#報告者|報告者]]としばらく連絡が取れない場合
34 1 toshi_a 初音
35
h3. 修正パッチがある場合
36
37
しばしば、バグ報告にいきなり修正パッチがついている場合がある。この場合、ステータスは「パッチ適用待ち」にする。
38
39
この遷移は、報告された問題の存在さえ確認できていれば、パッチの良し悪しに関わらず行って良い。パッチ自体の品質については、あとで判断する。
40
41
h3. パッチがない場合
42
43 2 toshi_a 初音
[[ロール#報告者|報告者]]がパッチを添付しない場合は、[[ロール#モデレータ|モデレータ]]はステータスを「実装待ち」にする。
44 1 toshi_a 初音
45
h2. ステータス「実装待ち」の場合
46
47
このステータスは、誰かが修正するのを待っている場合、又は修正方法を議論している場合。
48
49
h3. コミッタ
50
51 2 toshi_a 初音
[[ロール#コミッタ|コミッタ]]は、このチケットの問題を解決するコミットをすることができる。
52 1 toshi_a 初音
53 2 toshi_a 初音
くわしいルールについては、 [[ロール#ブランチの起点について|ブランチの起点について]] に従う。
54 1 toshi_a 初音
55
このブランチをPushしたら、チケットのステータスを「レビュー待ち」に変更する。
56
57
この時、次のフィールドをそれぞれ以下のようにする。
58
59
* *ステータス*: 「レビュー待ち」
60
* *ブランチ名*: コミットしたブランチ名を入れる。
61 2 toshi_a 初音
* *担当者*: ([[ロール#報告者|報告者]])。この更新をしている本人が[[ロール#報告者|報告者]]だった場合は担当なしにする。
62 1 toshi_a 初音
63
h3. コミッタ以外
64
65 2 toshi_a 初音
[[ロール#コミッタ|コミッタ]]でない人でも修正パッチを添付して注記を追加することができる。この場合は、同時にステータスを「パッチ適用待ち」にする。
66 1 toshi_a 初音
67
h2. ステータス「パッチ適用待ち」の場合
68
69 2 toshi_a 初音
このステータスの時にやるべきことは、単にそのパッチをコミットすることである。したがって、このステータスのチケットは[[ロール#コミッタ|コミッタ]]しか操作することができない。
70 1 toshi_a 初音
71
h3. パッチをコミットする
72
73 2 toshi_a 初音
[[ロール#コミッタ|コミッタ]]は、「パッチ適用待ち」のコミットを見たら、いつでもこのパッチをコミットできる。
74 1 toshi_a 初音
75 2 toshi_a 初音
詳細は [[ロール#ブランチの起点について|ブランチの起点について]] に従う。
76 1 toshi_a 初音
77
ただし、コミットする時にはgitコマンドの--authorオプションを使って、パッチを作った人をAuthorにすること。
78
79
このブランチをPushしたら、チケットのステータスを「レビュー待ち」に変更する。
80
81
この時、次のフィールドをそれぞれ以下のようにする。
82
83
- *ステータス*: 「レビュー待ち」
84
- *ブランチ名*: コミットしたブランチ名を入れる。
85 2 toshi_a 初音
- *担当者*: ([[ロール#修正者|修正者]])
86 1 toshi_a 初音
87
h2. ステータス「レビュー待ち」の場合
88
89
このステータスになる時、必ずカスタムフィールド「ブランチ名」に、修正がコミットされたブランチが書いてある。
90
91
h3. チケットの担当者が設定されてる場合
92
93
この場合は、設定された担当者がそのブランチをチェックアウトして動作確認を行う。
94
95
結果、このチケットで指摘されているバグが修正されたことが確認できたら、ステータスを「マージ待ち」にする。
96
97
* *ステータス*: 「マージ待ち」
98
* *担当者*: 担当者なし
99
100
稀に、正しく意図が伝わっていなかったり別のバグが発生していることもある。そういう時にはチケットのフィールドを以下のように更新する。
101
102
* *ステータス*: 「まだダメ」
103
* *担当者*: このチケットのステータスを「レビュー待ち」に変えた人
104
* *注記*: どういった不具合が発生しているかを詳細に説明する。UI関連ならスクリーンショットなどを貼ると良い。
105
106
h2. ステータス「マージ待ち」の場合
107
108 2 toshi_a 初音
このステータスになったチケットは、全ての修正、確認が終わっている。したがって[[ロール#コミッタ|コミッタ]]はすぐにこれをmergeしてよい。
109 1 toshi_a 初音
110
ただし、mergeするブランチには注意すること。次のルールに従う。
111
112
* *developブランチから派生したブランチ* → developブランチにmergeする
113
* *タグ又はmasterから派生したブランチ* → masterブランチにmergeする
114
115
上記のルールに従ってmasterかdevelopにmergeしたら、チケットのフィールド「ブランチ名」のブランチは削除する。
116
117
その後、チケットのフィールドを以下のように更新する。
118
119
* *ステータス*: 「終了」
120
121
また、masterにmergeした場合は、そのmasterを更にdevelopにmergeしてもよい(see: [[リポジトリのブランチ名の規約]])。逆の、masterをdevelopにmergeするのは、マイナーリリースを行う時なので、toshi_a以外が行ってはならない。
122
123
h1. その他
124
125
h2. ブランチの起点について
126
127
ブランチ名は @topic/(チケット番号)-(適当な説明)@ という書式にする(例: <code>topic/1234-fix-hogehoge</code>)。
128
129
また、ブランチを始めるリビジョンも重要になってくる。以下のうちのどれかを選択する。可能な限り上のものを選択すること。
130
131
* そのチケットの対象バージョンがサポートされているバージョンなら、最新の版のタグ
132
* masterのHEAD
133
* developのHEAD
134
135
例えば最新バージョンが1.1.4で、1.2を開発中だとすると:
136
137
* チケットの対象バージョンが1.1だった場合、タグ「1.1.4」からブランチを作る。
138
* 開発終了した1.0が対象バージョンだった場合、タグ「1.1.4」からブランチを作る。
139
* そのバグが未リリース(まだタグを打たれていないmasterブランチ)の場合、masterブランチのHEADからブランチを作る。
140
* チケットの対象バージョンが1.2だった場合、developブランチのHEADからブランチを作る。
141
142
となる。
143
144
また、コミットの一行目の末尾には、「refs #(チケット番号)」を必ず入れること。これによって自動的にチケットとコミットが関連付けられる。
145
146
もしPushしてからrefsの入れ忘れに気づいてしまった場合は、Redmineでそのコミットを開き、「関連するチケット」にそのチケット番号を追加すれば、手動で関連付けることができる。