Skip to content

Commit 671a0cd

Browse files
author
Niko Matsakis
committed
update the docs
1 parent 3be1224 commit 671a0cd

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

src/how_to/report_status.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,23 @@ We will recursively open up the "see also" issue and extract checkboxes (or sear
5858

5959
If we don't find any of the above, we will consider your issue either 0% done if it is not yet closed or 100% done if it is.
6060

61-
## Status update comments
61+
## Status update comments and summaries
6262

63-
Status updates are posted as comments on the Github tracking issue. You will receive regular pings on Zulip to author status updates periodically. It's a good idea to take the opportunity to update your [progress checkboxes](#checkboxes) as well.
64-
65-
There is no strict format for these updates but we recommend including the following information:
63+
We encourage you to post regular detailed updates about your progress as comments on the Github tracking issue. There is no strict format for these updates but we recommend including the following information:
6664

6765
* What happened since the last update? Were any key decisions made or milestones achieved?
6866
* What is the next step to get done?
6967
* Are you blocked on anyone or anything?
70-
* Is there any opportunity to others to pitch in and help out?
68+
69+
Status update comments will be included verbatim in a "details" section of the monthly blog post.
70+
71+
### Help wanted comments
72+
73+
If your updates include the text `Help wanted:` or `**Help wanted:**` at the start of a line, then the remainder of that line (and any non-block lines afterwards) will be extracted as a "help wanted" request. This will be highlighted in the monthly blog post.
74+
75+
### Summary comments
76+
77+
Once per month, you will start receiving pings to author a monthly status update. This is a special update that will be included verbatim in the blog post. Unless you have a flagship goal, the monthly status update should be short, no more than 2 or 3 bullet points. For a flagship goal it can be longer. To write your monthly status update, leave a comment that begins with the text "TL;DR:". It's a good idea to take the opportunity to update your [progress checkboxes](#checkboxes) as well, as the status bar in the blog post will be based on those.
7178

7279
## Closing the issue
7380

0 commit comments

Comments
 (0)