Skip to content

Commit d5f56d0

Browse files
BillWagnergewarrentdykstra
authored
update our readme (#38674)
* update our readme Fixes #38659 Periodic update to our readme to match our current processes. * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update issues-policy.md Co-authored-by: Tom Dykstra <[email protected]> * respond to feedback. --------- Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Tom Dykstra <[email protected]>
1 parent adfe867 commit d5f56d0

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@
1010

1111
This repository contains the conceptual documentation for .NET. The [.NET documentation site](https://learn.microsoft.com/dotnet) is built from multiple repositories in addition to this one:
1212

13+
- [.NET Desktop workloads](https://github.com/dotnet/docs-desktop)
14+
- [.NET Aspire](https://github.com/dotnet/docs-aspire)
1315
- [API reference](https://github.com/dotnet/dotnet-api-docs)
1416
- [.NET Compiler Platform SDK reference](https://github.com/dotnet/roslyn-api-docs)
17+
- [C# specification - draft](https://github.com/dotnet/csharpstandard)
18+
- [C# Language design](https://github.com/dotnet/csharplang)
1519

16-
Issues and tasks for all but the API reference repository are tracked here. We have a large community using these resources. We make our best effort to respond to issues in a timely fashion. You can read more about our procedures for classifying and resolving issues in our [Issues policy](issues-policy.md) topic. To create a new issue, [choose from any of the available templates](https://github.com/dotnet/docs/issues/new/choose).
20+
Our team's tasks are tracked in our [project boards](https://github.com/dotnet/docs/projects?query=is%3Aopen). You'll see monthly sprint projects, along with long-running projects for major documentation updates. The projects contain documentation issues across the repositories that build .NET docs. Issues are tracked in the relevant repositories. We have a large community using these resources. We make our best effort to respond to issues in a timely fashion. You can read more about our procedures for classifying and resolving issues in our [Issues policy](issues-policy.md) topic. To create a new issue, click the "Open a documentation issue" button at the bottom of any of our published docs, or [choose one of the available templates](https://github.com/dotnet/docs/issues/new/choose). The control at the bottom of each article automatically routes you to the correct repo and fills in some relevant information based on the article.
1721

1822
## :purple_heart: Contribute
1923

issues-policy.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ Evaluating the correct course of action is subjective. The team members use thei
4949
For other issues, the team:
5050

5151
- Assigns a priority
52-
- Assigns a milestone, usually "Backlog"
53-
- Assesses if an issue is a good "up for grabs" issue, or the [Projects for .NET Community Contributors](https://github.com/dotnet/docs/projects/35)
52+
- If high enough priority, assigns to an upcoming monthly sprint.
53+
- If the fix is clear, adds the "help-wanted" label.
5454

5555
Priority levels are based on the following guidelines but are subjective. The milestones are also subjective and are based on other priorities such as current product release schedules and upcoming launches.
5656

@@ -65,9 +65,7 @@ Priority levels are based on the following guidelines but are subjective. The mi
6565

6666
Team members spend a limited amount of time on diagnosis and triage so they can make progress on scheduled tasks. Each team member spends at most 30 minutes per day in diagnosis and triage.
6767

68-
The **up-for-grabs** label is applied when an issue is a good candidate for a community member (possibly the author) to submit a fix. The team member that applies the **up-for-grabs** label will help or find someone to help community members work through the PR creation process. Issues that are "up for grabs" are often added to the [Community Contribution projects](https://github.com/dotnet/docs/projects/35)
69-
70-
> NOTE: We've only recently adopted the preceding convention. The person that added the label may refer you to another team member who will help.
68+
The **help-wanted** label is applied when an issue is a good candidate for a community member (possibly the author) to submit a fix. The team member that applies the **help-wanted** label will help or find someone to help community members work through the PR creation process.
7169

7270
## Resolution phase
7371

0 commit comments

Comments
 (0)