Skip to content

Commit 8dcc1d2

Browse files
committed
Merged in [12545] from rjsparks@nostrum.com:
Allow a review request to include a comment to show to the review team secretary at assignment time and the reviewer at review time. Fixes ietf-tools#2096. - Legacy-Id: 12548 Note: SVN reference [12545] has been migrated to Git commit 6fcd8b8
1 parent eafa070 commit 8dcc1d2

8 files changed

Lines changed: 45 additions & 4 deletions

File tree

ietf/doc/tests_review.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ def test_request_review(self):
6464
"deadline": deadline.isoformat(),
6565
"requested_rev": "01",
6666
"requested_by": Person.objects.get(user__username="reviewsecretary").pk,
67+
"comment": "gZT2iiYqYLKiQHvsgWCcVLdH"
6768
})
6869
self.assertEqual(r.status_code, 302)
6970

@@ -74,6 +75,7 @@ def test_request_review(self):
7475
self.assertEqual(req.deadline, deadline)
7576
self.assertEqual(req.requested_rev, "01")
7677
self.assertEqual(doc.latest_event().type, "requested_review")
78+
self.assertEqual(req.comment, "gZT2iiYqYLKiQHvsgWCcVLdH")
7779

7880
def test_request_review_of_rfc(self):
7981
make_test_data()

ietf/doc/views_review.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class RequestReviewForm(forms.ModelForm):
4646

4747
class Meta:
4848
model = ReviewRequest
49-
fields = ('requested_by', 'type', 'deadline', 'requested_rev')
49+
fields = ('requested_by', 'type', 'deadline', 'requested_rev', 'comment')
5050

5151
def __init__(self, user, doc, *args, **kwargs):
5252
super(RequestReviewForm, self).__init__(*args, **kwargs)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# -*- coding: utf-8 -*-
2+
from __future__ import unicode_literals
3+
4+
from django.db import migrations, models
5+
6+
7+
class Migration(migrations.Migration):
8+
9+
dependencies = [
10+
('review', '0009_auto_20161214_1537'),
11+
]
12+
13+
operations = [
14+
migrations.AddField(
15+
model_name='reviewrequest',
16+
name='comment',
17+
field=models.CharField(default=b'', help_text=b'Provide any additional information to show to the review team secretary and reviewer', max_length=2048, verbose_name=b"Requester's comments and instructions", blank=True),
18+
),
19+
]

ietf/review/models.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ class ReviewRequest(models.Model):
142142
deadline = models.DateField()
143143
requested_by = models.ForeignKey(Person)
144144
requested_rev = models.CharField(verbose_name="requested revision", max_length=16, blank=True, help_text="Fill in if a specific revision is to be reviewed, e.g. 02")
145+
comment = models.TextField(verbose_name="Requester's comments and instructions", max_length=2048, blank=True, help_text="Provide any additional information to show to the review team secretary and reviewer", default='')
145146

146147
# Fields filled in as reviewer is assigned and as the review is
147148
# uploaded. Once these are filled in and we progress beyond being

ietf/review/resources.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,19 @@ class Meta:
3333
}
3434
api.review.register(ReviewerSettingsResource())
3535

36+
37+
3638
from ietf.doc.resources import DocumentResource
37-
from ietf.group.resources import RoleResource, GroupResource
39+
from ietf.group.resources import GroupResource
3840
from ietf.name.resources import ReviewRequestStateNameResource, ReviewResultNameResource, ReviewTypeNameResource
41+
from ietf.person.resources import PersonResource, EmailResource
3942
class ReviewRequestResource(ModelResource):
4043
state = ToOneField(ReviewRequestStateNameResource, 'state')
4144
type = ToOneField(ReviewTypeNameResource, 'type')
4245
doc = ToOneField(DocumentResource, 'doc')
4346
team = ToOneField(GroupResource, 'team')
44-
reviewer = ToOneField(RoleResource, 'reviewer', null=True)
47+
requested_by = ToOneField(PersonResource, 'requested_by')
48+
reviewer = ToOneField(EmailResource, 'reviewer', null=True)
4549
review = ToOneField(DocumentResource, 'review', null=True)
4650
result = ToOneField(ReviewResultNameResource, 'result', null=True)
4751
class Meta:
@@ -51,14 +55,17 @@ class Meta:
5155
#resource_name = 'reviewrequest'
5256
filtering = {
5357
"id": ALL,
58+
"old_id": ALL,
5459
"time": ALL,
5560
"deadline": ALL,
5661
"requested_rev": ALL,
62+
"comment": ALL,
5763
"reviewed_rev": ALL,
5864
"state": ALL_WITH_RELATIONS,
5965
"type": ALL_WITH_RELATIONS,
6066
"doc": ALL_WITH_RELATIONS,
6167
"team": ALL_WITH_RELATIONS,
68+
"requested_by": ALL_WITH_RELATIONS,
6269
"reviewer": ALL_WITH_RELATIONS,
6370
"review": ALL_WITH_RELATIONS,
6471
"result": ALL_WITH_RELATIONS,

ietf/templates/doc/review/request_review.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ <h1>Request review<br><small>{{ doc.name }}</small></h1>
3535
{% bootstrap_field form.team layout="horizontal" %}
3636
{% bootstrap_field form.deadline layout="horizontal" %}
3737
{% bootstrap_field form.requested_rev layout="horizontal" %}
38+
{% bootstrap_field form.comment layout="horizontal" %}
3839

3940
{% buttons %}
4041
<button type="submit" class="btn btn-primary">Request review</button>

ietf/templates/doc/review/review_request.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ <h1>Review request<br><small>{{ review_req.doc.name }}</small></h1>
6666
<td>{{ review_req.requested_by }}</td>
6767
</tr>
6868
{% endif %}
69+
70+
{% if review_req.comment %}
71+
<tr>
72+
<th></th>
73+
<th>Comments</th>
74+
<td><pre class="pasted">{{review_req.comment}}</pre></td>
75+
</tr>
76+
{% endif %}
6977
</tbody>
7078

7179
<tbody class="meta">

ietf/templates/group/manage_review_requests.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h3 class="panel-title">
6060
<div class="col-sm-6">
6161
<div class="request-metadata">
6262
<p>
63-
{% if r.pk != None %}Requested: <a href="{% url "ietf.doc.views_review.review_request" name=r.doc.name request_id=r.pk %}">{{ r.time|date:"Y-m-d" }}</a>
63+
{% if r.pk != None %}Requested: <a href="{% url "ietf.doc.views_review.review_request" name=r.doc.name request_id=r.pk %}">{{ r.time|date:"Y-m-d" }}{% if r.requested_by %} by {{r.requested_by.plain_name}}{% endif %}</a>
6464
{% else %}
6565
Auto-suggested
6666
{% endif %}
@@ -96,6 +96,9 @@ <h3 class="panel-title">
9696
- <a href="{% url "ietf.group.views.group_home" acronym=r.doc.group.acronym group_type=r.doc.group.type_id %}">{{ r.doc.group.acronym }} {{ r.doc.group.type.name }}</a>
9797
{% endif %}
9898
</div>
99+
{% if r.comment %}
100+
<div><pre class="pasted">{{ r.comment }}</pre></div>
101+
{% endif %}
99102
</div>
100103

101104
<div class="col-sm-6 abstract">

0 commit comments

Comments
 (0)