Skip to content

Commit

Permalink
update our readme (dotnet#38674)
Browse files Browse the repository at this point in the history
* update our readme

Fixes dotnet#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]>
  • Loading branch information
3 people authored Dec 12, 2023
1 parent adfe867 commit d5f56d0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@

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:

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

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).
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.

## :purple_heart: Contribute

Expand Down
8 changes: 3 additions & 5 deletions issues-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Evaluating the correct course of action is subjective. The team members use thei
For other issues, the team:

- Assigns a priority
- Assigns a milestone, usually "Backlog"
- 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)
- If high enough priority, assigns to an upcoming monthly sprint.
- If the fix is clear, adds the "help-wanted" label.

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.

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

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.

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)

> 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.
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.

## Resolution phase

Expand Down

0 comments on commit d5f56d0

Please sign in to comment.