Skip to content

Commit a166d50

Browse files
committed
Rework labelling. More succinct, labels match actions, not statuses
Categories are labels/titles and should use title case. Use initial capital letter on all non-joining words. In Progress is an OK label choice but Ongoing communicates the same thing with a single word just like all the other options. In the workflow the "Parked" status is being used for commitfests labelled, e.g., Draft v18, so use Drafts as the category label too. Change Open to Bugs to relfect its new usage. Once committed a large technical refactor/rename pass over the models and code to make the enums match up with the usage is planned.
1 parent 1ef5da6 commit a166d50

File tree

4 files changed

+38
-38
lines changed

4 files changed

+38
-38
lines changed

pgcommitfest/commitfest/models.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ class CommitFest(models.Model):
4242
STATUS_PARKED = 5
4343
_STATUS_CHOICES = (
4444
(STATUS_FUTURE, "Future"),
45-
(STATUS_OPEN, "Open"),
46-
(STATUS_INPROGRESS, "In Progress"),
45+
(STATUS_OPEN, "Bugs"),
46+
(STATUS_INPROGRESS, "Ongoing"),
4747
(STATUS_CLOSED, "Closed"),
48-
(STATUS_PARKED, "Parked"),
48+
(STATUS_PARKED, "Drafts"),
4949
)
5050
_STATUS_LABELS = (
5151
(STATUS_FUTURE, "default"),
@@ -255,13 +255,13 @@ class PatchOnCommitFest(models.Model):
255255
STATUS_RETURNED = 7
256256
STATUS_WITHDRAWN = 8
257257
_STATUS_CHOICES = (
258-
(STATUS_REVIEW, "Needs review"),
258+
(STATUS_REVIEW, "Needs Review"),
259259
(STATUS_AUTHOR, "Waiting on Author"),
260260
(STATUS_COMMITTER, "Ready for Committer"),
261261
(STATUS_COMMITTED, "Committed"),
262-
(STATUS_NEXT, "Moved to next CF"),
262+
(STATUS_NEXT, "Moved"),
263263
(STATUS_REJECTED, "Rejected"),
264-
(STATUS_RETURNED, "Returned with feedback"),
264+
(STATUS_RETURNED, "Returned with Feedback"),
265265
(STATUS_WITHDRAWN, "Withdrawn"),
266266
)
267267
_STATUS_LABELS = (

pgcommitfest/commitfest/templates/patch_administrative.inc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@
1212
<div class="btn-group">
1313
<a class="btn btn-default dropdown-toggle" data-toggle="dropdown" href="#">Change Status <span class="caret"></span></a>
1414
<ul class="dropdown-menu" role="menu">
15-
<li role="presentation" class="dropdown-header">Open statuses</li>
16-
<li role="presentation"><a href="status/review/">Needs review</a></li>
17-
<li role="presentation"><a href="status/author/">Waiting on Author</a></li>
18-
<li role="presentation"><a href="status/committer/">Ready for Committer</a></li>
15+
<li role="presentation" class="dropdown-header">Assign to:</li>
16+
<li role="presentation"><a href="status/review/">Reviewer</a></li>
17+
<li role="presentation"><a href="status/author/">Author</a></li>
18+
<li role="presentation"><a href="status/committer/">Committer</a></li>
1919
<li role="presentation" class="divider"></li>
20-
<li role="presentation" class="dropdown-header">Closed statuses</li>
21-
<li role="presentation"><a href="close/reject/" onclick="return verify_reject()">Rejected</a></li>
22-
<li role="presentation"><a href="close/withdrawn/" onclick="return verify_withdrawn()">Withdrawn</a></li>
23-
<li role="presentation"><a href="close/feedback/" onclick="return verify_returned()">Returned with feedback</a></li>
24-
<li role="presentation"><a href="close/committed/" onclick="return flagCommitted({%if patch.committer%}'{{patch.committer}}'{%elif is_committer%}'{{user.username}}'{%else%}null{%endif%})">Committed</a></li>
20+
<li role="presentation" class="dropdown-header">Resolve:</li>
21+
<li role="presentation"><a href="close/reject/" onclick="return verify_reject()">Reject</a></li>
22+
<li role="presentation"><a href="close/withdrawn/" onclick="return verify_withdrawn()">Withdraw</a></li>
23+
<li role="presentation"><a href="close/feedback/" onclick="return verify_returned()">Return</a></li>
24+
<li role="presentation"><a href="close/committed/" onclick="return flagCommitted({%if patch.committer%}'{{patch.committer}}'{%elif is_committer%}'{{user.username}}'{%else%}null{%endif%})">Commit</a></li>
2525
<li role="presentation" class="divider"></li>
26-
<li role="presentation" class="dropdown-header">Move To Options</li>
26+
<li role="presentation" class="dropdown-header">Move To:</li>
2727
{%if not cf.isfuture and workflow.future %}
2828
<li role="presentation">
2929
<a

pgcommitfest/commitfest/templates/patch_workflow.inc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,13 @@
106106
<div>{{reviewer.first_name}} {{reviewer.last_name}}</div>
107107
{%endfor%}
108108
{%if user.is_authenticated %}
109-
<div><a href="reviewer/{{is_reviewer|yesno:"remove,become"}}/" class="btn btn-default">{{is_reviewer|yesno:"Remove from reviewers,Become reviewer"}}</a></div>
109+
<div><a href="reviewer/{{is_reviewer|yesno:"remove,become"}}/" class="btn btn-default">{{is_reviewer|yesno:"Remove Self,Become Reviewer"}}</a></div>
110110
{%endif%}
111111
</td>
112112
<!-- Resolve -->
113113
<td>
114114
{%if patch.committer%}<div>{{patch.committer.fullname}}</div>{%endif%}
115-
{%if is_committer%}<div><a href="committer/{{is_this_committer|yesno:"remove,become"}}/" class="btn btn-default">{{is_this_committer|yesno:"Unclaim as committer,Claim as committer"}}</a></div>{%endif%}
115+
{%if is_committer%}<div><a href="committer/{{is_this_committer|yesno:"remove,become"}}/" class="btn btn-default">{{is_this_committer|yesno:"Unclaim,Claim for Self"}}</a></div>{%endif%}
116116
</td>
117117
<!-- Move -->
118118
<td>

pgcommitfest/commitfest/templates/workflow.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ <h3>The Commitfest Workflow</h3>
1515
after which they are "Closed" and a new bin for the same category is created.
1616
Each bin serves a role in the workflow and there are 4 active categories of bins.
1717
<ul>
18-
<li>Open - annual, all bug reports</li>
19-
<li>Parked - annual, drafts for new features</li>
20-
<li>Future - scheduled, proposed new features</li>
21-
<li>In Progress - scheduled, review and commit new features</li>
18+
<li>Bugs - annual, all bug reports</li>
19+
<li>Drafts - annual, drafts for new features</li>
20+
<li>Next - scheduled, proposed new features</li>
21+
<li>Ongoing - scheduled, review and commit new features</li>
2222
</ul>
2323
There are three active categories of patch status covering the four statuses.
2424
<ul>
@@ -36,34 +36,34 @@ <h3>The Commitfest Workflow</h3>
3636
(See notes below for all available statuses and their intended usage.)
3737
</p>
3838
<p>
39-
The patches in the open bin are all of type "bug fix". The full lifecycle of
39+
The patches in the bugs bin are all of type "bug fix". The full lifecycle of
4040
a bux fix patch lives here and there is no distinction as to the nature of the
4141
reviewer category. The remaining bins exist to help deal with the large volume
4242
of new feature patches.
4343
</p>
4444
<p>
45-
The parked bin is where patches waiting on significant work go. A reviewer
45+
The drafts bin is where patches waiting on significant work go. A reviewer
4646
patch status category here mainly means awaiting guidance, though that will
4747
often lead to a final review, allowing the patch to be moved to the future bin
4848
with the committer patch status category already set.
4949
</p>
5050
<p>
51-
The future and in progress bins are the ones that strictly comprise a commitfest.
51+
The future and ongoing bins are the ones that strictly comprise a commitfest.
5252
The future bin always exists and new features ready for review and commit go
53-
here. At scheduled points, the future bin becomes an in progress bin and a new
53+
here. At scheduled points, the future bin becomes an ongoing bin and a new
5454
future bin is created.
5555
</p>
5656
<p>
57-
The in progress bin only exists during an active commitfest period, during which
57+
The ongoing bin only exists during an active commitfest period, during which
5858
no new patches should be added and the community reviewers and committers are
5959
encouraged to focus on reviews and commits. At the end of the scheduled period
6060
the bin is closed. This is only bin that is not present at all times.
6161
</p>
6262
<p>
6363
The workflow is also designed with the release cycle in mind, in particular
64-
the start of the annual feature freeze period. At this time both the parked
65-
and open bins are closed and new ones created. If the feature freeze is for
66-
version 18 then the new parked bin is called "Drafts v19" and the new open
64+
the start of the annual feature freeze period. At this time both the drafts
65+
and bugs bins are closed and new ones created. If the feature freeze is for
66+
version 18 then the new drafts bin is called "Drafts v19" and the new bugs
6767
bin is named "Bugs v18".
6868
</p>
6969
<h3>Patches on Commitfests (PoC)</h3>
@@ -178,40 +178,40 @@ <h4>Overview</h4>
178178
of a patch to be keyed to commitfest status type without the need for further
179179
disambiguation.
180180
</p>
181-
<h4>In Progress</h4>
181+
<h4>Ongoing</h4>
182182
<p>
183183
An Active (see Workflow above) period where no new features should be added
184184
and the goal is to get as many review"patches committed as possible.
185185
</p>
186186
<h4>Future</h4>
187187
<p>
188188
The next active (see workflow above) period.
189-
Any patch not exempted to be added to the in progress or open commitfests
189+
Any patch not exempted to be added to the ongoing or bugs commitfests
190190
can always be added here.
191191
</p>
192-
<h4>Open</h4>
192+
<h4>Bugs</h4>
193193
<p>
194194
A commitfest for high-priority and bug fix patches. Full patch lifecycle.
195195
Created as "Bugs v18" at the start of the v18 feature freeze period (closing
196196
"Bugs v17").
197197
</p>
198-
<h4>Parked</h4>
198+
<h4>Drafts</h4>
199199
<p>
200-
The commitfest setup as parked is used to hold patches that are not intended
200+
The commitfest setup as drafts is used to hold patches that are not intended
201201
to be formally reviewed and committed. Another term is "work-in-progress" (WIP).
202202
Within the Workflow, at the start of the v18 feature freeze, the existing
203203
"Draft v18" commitfest is closed and a new "Draft v19" commitfest is created.
204204
This allows for a fresh start coinciding with the project release cycle.
205-
And while commits cannot accumulate within a parked commitfest, withdrawn and
205+
And while commits cannot accumulate within a drafts commitfest, withdrawn and
206206
rejected patches would and so having a truly never-closing commitfest is not
207207
ideal. Similarly, given the volume of patches, getting rid of abandonment
208208
is counter-productive. This workflow provides a middle-ground between
209209
every-other-month and never patch moving requirements.
210210
</p>
211211
<h4>Closed</h4>
212212
<p>
213-
Parked, open and in progress commitfests are closed (future ones
214-
always go through in progress) when the period they cover has passed.
213+
Drafts, bugs and ongoing commitfests are closed (future ones
214+
always go through ongoing) when the period they cover has passed.
215215
Closing a commitfest does not impact its related PoCs; though no new PoCs can
216216
be created for a closed commitfest.
217217
</p>

0 commit comments

Comments
 (0)