-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathIssueTracking.html
284 lines (241 loc) · 13 KB
/
IssueTracking.html
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Mantid Issue Tracking</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=fadd4351" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=77160d70" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="User Support" href="UserSupport.html" />
<link rel="prev" title="Communication" href="Communication.html" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59110517-1', 'auto');
ga('send', 'pageview');
</script>
</head><body>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://www.mantidproject.org">
</a>
<span class="navbar-text navbar-version pull-left"><b>main</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="index.html">Home</a></li>
<li><a href="https://download.mantidproject.org">Download</a></li>
<li><a href="https://docs.mantidproject.org">User Documentation</a></li>
<li><a href="http://www.mantidproject.org/contact">Contact Us</a></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html">Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Mantid Issue Tracking</a></li>
</ul>
</div> </p>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="mantid-issue-tracking">
<span id="issue-tracking"></span><h1>Mantid Issue Tracking<a class="headerlink" href="#mantid-issue-tracking" title="Link to this heading">¶</a></h1>
<p>Mantid uses GitHub issues to track new feature and bugfix
development. The issue tracker can be found at <a class="reference external" href="https://github.com/mantidproject/mantid/issues">GitHub</a></p>
<nav class="contents local" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#workflow" id="id1">Workflow</a></p></li>
<li><p><a class="reference internal" href="#creating-an-issue" id="id2">Creating an Issue</a></p></li>
<li><p><a class="reference internal" href="#labels" id="id3">Labels</a></p></li>
<li><p><a class="reference internal" href="#filtering-issues" id="id4">Filtering Issues</a></p>
<ul>
<li><p><a class="reference internal" href="#your-issues" id="id5">Your Issues</a></p></li>
<li><p><a class="reference internal" href="#for-review" id="id6">For Review</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="workflow">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Workflow</a><a class="headerlink" href="#workflow" title="Link to this heading">¶</a></h2>
<p>Every piece of work starts with an open issue. To find issues that are
assigned to you see the section
<a class="reference internal" href="#issuetrackingyourissues"><span class="std std-ref">Your Issues</span></a>. How an issue is closed is
then dependent on its requirements:</p>
<ul class="simple">
<li><p>Code changes required: generate a <strong>pull request</strong>
(<a class="reference internal" href="GitWorkflow.html#gitworkflowpullrequests"><span class="std std-ref">Pull Requests</span></a>)</p>
<ul>
<li><p>Make sure the issue is referenced with <code class="docutils literal notranslate"><span class="pre">#issue-number</span></code>. It will
then be closed when the pull request is merged</p></li>
</ul>
</li>
<li><p>No code changes required: Close the issue, with a comment explaining
why the issue should be closed, for example:</p>
<ul>
<li><p>This is a duplicate of #1234</p></li>
<li><p>This works for me, when I try the following steps ….</p></li>
<li><p>I’ve spoken to the author of this issue and it does not happen for
them either anymore</p></li>
<li><p>Contacted the instrument scientists that raised this issue and it
has been solved since version 3.4</p></li>
<li><p>After further investigation we are not going to continue with this
for the following reasons … The author of this ticket has been
informed.</p></li>
<li><p>(If the issue is an <strong>umbrella</strong> issue, indicated by the
<strong>Roadmap</strong> label) All points in this issue have been addressed
elsewhere (see issues X, Y, Z)</p></li>
</ul>
</li>
</ul>
</section>
<section id="creating-an-issue">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Creating an Issue</a><a class="headerlink" href="#creating-an-issue" title="Link to this heading">¶</a></h2>
<p>Go <a class="reference external" href="https://github.com/mantidproject/mantid/issues/new">here</a> to
create a new issue. Make sure you assign the appropriate labels (see
<a class="reference internal" href="#issuetrackinglabels"><span class="std std-ref">Labels</span></a>) and milestone.</p>
</section>
<section id="labels">
<span id="issuetrackinglabels"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Labels</a><a class="headerlink" href="#labels" title="Link to this heading">¶</a></h2>
<p>GitHub allows you to assign various labels to your issues and pull
requests. Labelling your issues and pull requests adequately will
ensure that they are picked up by the right people.</p>
<p>Labels fall into several groups: (<em>please note that ‘ticket’ is used
to refer to either an issue or a PR on this page</em>)</p>
<ul class="simple">
<li><p><strong>Component</strong> - which area of Mantid the ticket concerns. The ticket
may be relevant to more than one area. Some commonly used
<strong>Component</strong> labels are:</p>
<ul>
<li><p><strong>Framework</strong>: tickets relating to Algorithms, Workspaces and
SimpleAPI</p></li>
<li><p><strong>GUI</strong> - tickets relating either to the main MantidWorkbench GUI, or
one if its custom interfaces</p></li>
<li><p><strong>Python</strong> - whether the change will be implemented in
Python. This is useful for labelling PRs, as branches in which all
changes are in Python often don’t need to be rebuilt to be tested,
so can be picked up more quickly</p></li>
</ul>
</li>
<li><p><strong>Group</strong> - you may belong to a group within Mantid, such as the
Reflectometry group. Use the corresponding label so that others in
your group can easily find your work to review it</p></li>
<li><p><strong>Misc</strong> - some of the more common <strong>misc</strong> labels are described
below:</p>
<ul>
<li><p><strong>Bug</strong> - used for issues or PRs which reference a specific bug in
the software (as opposed to a new feature, or general
improvements)</p></li>
<li><p><strong>Induction</strong> - if you come across an issue that may be good for a
new starter (not too difficult, low risk, the relevant code is
comprehensively tested, low(ish) priority) don’t hog it for
yourself! Put this label on it so that it can be picked up as an
introduction to the Mantid codebase</p></li>
<li><p><strong>Roadmap</strong> - useful when planning out a large piece of work - use
this to map out the steps you’ll need to take along the way. This
will usually subsume several smaller issues</p></li>
</ul>
</li>
<li><p><strong>Priority</strong></p>
<ul>
<li><p><strong>Priority: High</strong> - use this if your ticket needs picking up
right away, for instance if it relates to a bug which affects a
large number of users. If you are unsure about an issue that could
be high priority, discuss with a senior developer. Issues marked
high priority must also have a justification for the priority
stated in the ticket</p></li>
<li><p><strong>No priority set</strong> - use this for tickets of intermediate priority
this will probably be your default setting, most issues will fall
into this category</p></li>
<li><p><strong>Priority: Low</strong> - use this for the “nice to have” tickets
this means that they are not necessarily urgent but can be
worked on if there is spare time</p></li>
</ul>
</li>
<li><p><strong>Patch candidate</strong> - following a release, low-risk tickets with
high impact on users will be considered for a follow-up (or <em>patch</em>
release). If your ticket matches this description, consider
labelling it as a patch candidate</p></li>
<li><p><strong>Quality</strong> - not all of Mantid is well-written. Use one of these
labels if your ticket involves improving the quality of the Mantid
codebase (these changes will usually be invisible to users)</p></li>
<li><p><strong>State: In Progress</strong> - use this label on a PR if the work in that
PR is still ongoing, and you don’t want a review yet. <strong>REMEMBER TO
REMOVE IT ONCE YOUR WORK IS READY FOR REVIEW</strong></p></li>
</ul>
</section>
<section id="filtering-issues">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Filtering Issues</a><a class="headerlink" href="#filtering-issues" title="Link to this heading">¶</a></h2>
<p>GitHub has a powerful issue filtering system that is described <a class="reference external" href="https://help.github.com/articles/searching-issues">here</a>. Below we list
some common searches that developers will need. It is advised to
bookmark these URLs.</p>
<section id="your-issues">
<span id="issuetrackingyourissues"></span><h3><a class="toc-backref" href="#id5" role="doc-backlink">Your Issues</a><a class="headerlink" href="#your-issues" title="Link to this heading">¶</a></h3>
<p>You can view the issues assigned to you by visiting the <a class="reference external" href="https://github.com/mantidproject/mantid/issues">list of
issues</a>, clicking on
the assignee drop down box and finding your name.</p>
</section>
<section id="for-review">
<h3><a class="toc-backref" href="#id6" role="doc-backlink">For Review</a><a class="headerlink" href="#for-review" title="Link to this heading">¶</a></h3>
<p>These are useful links to view when you are looking to review/test an
issue or pull request:</p>
<ul class="simple">
<li><p>Go <a class="reference external" href="https://github.com/mantidproject/mantid/pulls?utf8=%E2%9C%93&q=-author%3AGITHUB-NAME-HERE+is%3Apr+is%3Aopen+-label%3A%22State%3A+In+Progress%22+no%3Aassignee+status%3Asuccess">here</a>
for pull requests that you did not create and no one else is
assigned. Please replace GITHUB-NAME-HERE with your GitHub username</p></li>
<li><p>Go <a class="reference external" href="https://github.com/mantidproject/mantid/issues?utf8=%E2%9C%93&q=-assignee%3AGITHUB-NAME-HERE+is%3Aissue+is%3Aopen+label%3A%22State%3A+Review+Required%22+">here</a>
for issues with no code changes to review. Please replace
GITHUB-NAME-HERE with your GitHub username</p></li>
</ul>
</section>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="nav navbar-nav" style=" float: right;">
<li>
<a href="Communication.html" title="Previous Chapter: Communication"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Communication</span>
</a>
</li>
<li>
<a href="UserSupport.html" title="Next Chapter: User Support"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">User Support »</span>
</a>
</li>
<li><a href="#">Back to top</a></li>
</ul>
<p>
</p>
</div>
</footer>
</body>
</html>