Skip to content

Commit c50ed73

Browse files
authored
Add required first level titles in doc files (#51708)
1 parent 73e0b53 commit c50ed73

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/HelpWantedIssueSummaryCommentTemplate.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
33
**IMPORTANT**: As part of posting this comment, please make sure:
44
- that the issue is properly labeled with both `area-` and `feature-` labels.
5-
- to apply one of the `Complexity: ` labels is applied to the issue [Simple | Medium | Hard]
5+
- to apply one of the `Complexity: <value>` labels is applied to the issue [Simple | Medium | Hard]
66
- for an issue which was marked with `Complexity: Simple` label, it may be a good fit for a first-time contributors to this repo.
77
If so, please also apply `good-first-issue` label.
88
-->
99

10+
# Help Wanted
11+
1012
## Issue Summary
1113

1214
<!-- This section will be filled in by the engineers assigned to this -->

docs/HelpWantedProcess.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Help Wanted Process
2+
13
This document describes the process that the team uses for identifying candidate issues for community members to tackle.
24

35
## Process
@@ -6,7 +8,7 @@ This process (we'll refer to it as `help-wanted` process going forward) triggers
68
1. The triage team will **assign the `help-candidate` label** to the issue, as well as **assign an engineer to the issue**.
79
2. The task for the assigned engineer will be to understand the ask based on all the comments in the issue and **summarize the problem in a comment** using the [Help Wanted Template](/docs/HelpWantedIssueSummaryCommentTemplate.md).
810
3. As part of filling out the template, the engineer will also need to **describe a high-level design for how to approach the problem and how it can be solved**.
9-
4. When all the sections of the template are filled in, the engineer will then need to **apply one of the `Complexity: ` labels**, to indicate how easy / hard will it be to tackle the issue.
11+
4. When all the sections of the template are filled in, the engineer will then need to **apply one of the `Complexity: <value>` labels**, to indicate how easy / hard will it be to tackle the issue.
1012
This will help community members to find the right type of issue to contribute to.
1113
5. After posting this comment, the assigned **engineer will unassign themself** from the issue and will **replace the `help-candidate` label with `help-wanted` label**, as an indicator, that the issue is ready for the community to pick up.
1214

0 commit comments

Comments
 (0)