Skip to content

Commit 73e0b53

Browse files
mkArtakMSFTdanmoseleyamcaseymartincostellodavid-acker
authored
Documenting the new help-wanted process (#51664)
* Create HelpWantedIssueSummaryCommentTemplate.md Adding the template that will be used by the engineers on the team on the help-wanted issues as part of the new process * Create HelpWantedProcess.md * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: Dan Moseley <danmose@microsoft.com> * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: Andrew Casey <amcasey@users.noreply.github.com> * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: Andrew Casey <amcasey@users.noreply.github.com> * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: Martin Costello <martin@martincostello.com> * Update HelpWantedIssueSummaryCommentTemplate.md * Update HelpWantedIssueSummaryCommentTemplate.md Addressing additional feedback * Update HelpWantedProcess.md * Update docs/HelpWantedProcess.md Co-authored-by: David Acker <davidacker3@gmail.com> * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: Martin Costello <martin@martincostello.com> * Update HelpWantedIssueSummaryCommentTemplate.md * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: David Acker <davidacker3@gmail.com> * Update docs/HelpWantedIssueSummaryCommentTemplate.md Co-authored-by: David Acker <davidacker3@gmail.com> --------- Co-authored-by: Dan Moseley <danmose@microsoft.com> Co-authored-by: Andrew Casey <amcasey@users.noreply.github.com> Co-authored-by: Martin Costello <martin@martincostello.com> Co-authored-by: David Acker <davidacker3@gmail.com>
1 parent 6c1b3df commit 73e0b53

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--
2+
3+
**IMPORTANT**: As part of posting this comment, please make sure:
4+
- 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]
6+
- for an issue which was marked with `Complexity: Simple` label, it may be a good fit for a first-time contributors to this repo.
7+
If so, please also apply `good-first-issue` label.
8+
-->
9+
10+
## Issue Summary
11+
12+
<!-- This section will be filled in by the engineers assigned to this -->
13+
14+
## Potential Design
15+
16+
<!-- This section is meant to be used for a high level design of what a solution should look like and/or what direction should be taken to solving this problem. -->
17+
18+
## Code References
19+
20+
<!-- Links to classes / methods which are critical to understand for building out this solution, as these are relevant and will be used by the solution, as well as existing test cases that exercise this code -->
21+
22+
## Relevant Documentation
23+
24+
<!-- Links to relevant documentation which you think is relevant for handling this issue -->
25+
26+
## Important Considerations
27+
28+
<!-- List of additional gotchas the community member who will be handling this issue will need to consider when working on the solution -->
29+
30+
## Additional Notes
31+
- If the change you are going to make will include a **public API change** in the framework, then the change will need to go through our [API Review Process](/docs/APIReviewProcess.md). Please read this process to take any necessary steps, to avoid any potential delays down the road with accepting this change.
32+
- If this is your first contribution to the repo, you may find it useful to learn [How to build the repo](/docs/BuildFromSource.md)
33+
- Please note, that the changes will be considered for the vNext version of the framework by default. That is, after the change gets merged in main, it will be available only in the next preview release of the framework and will be shipped in the upcoming major release of the product.

docs/HelpWantedProcess.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
This document describes the process that the team uses for identifying candidate issues for community members to tackle.
2+
3+
## Process
4+
5+
This process (we'll refer to it as `help-wanted` process going forward) triggers from the moment, when the engineering team decides that a particular issue may be a good fit for a community member to tackle. Below are the stages that issue will go through, as part of this process:
6+
1. The triage team will **assign the `help-candidate` label** to the issue, as well as **assign an engineer to the issue**.
7+
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).
8+
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.
10+
This will help community members to find the right type of issue to contribute to.
11+
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.
12+
13+
This will conclude the process.

0 commit comments

Comments
 (0)