Skip to content

Commit

Permalink
Rearrange files + add README
Browse files Browse the repository at this point in the history
  • Loading branch information
jfversluis committed Aug 3, 2022
1 parent e7be0d8 commit b82e840
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 4 deletions.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Contributor documentation
=========================

The primary audience for documentation in this folder is contributors to .NET MAUI.
If you are looking for documentation on how to *use* .NET MAUI, go to <https://docs.microsoft.com/dotnet/maui/>.

<!--TODO: >> :bulb: If you're a new contributor looking to set up the repo locally, the [build from source documentation](BuildFromSource.md) is the best place to start.-->

The table below outlines the different docs in this folder and what they are helpful for.

| Documentation | What is it about? | Who is it for? |
|--------------------------------------------------------------------------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| [Issue management](IssueManagementPolicies.md) | Overview of policies in place to manage issues| Community members and collaborators looking to understand how we handle closed issue, issues that need author feedback, etc | |
| [Triage process](TriageProcess.md)| Overview of the issue triage process used in the repo | Anyone looking to understand the triage process on the repo |
4 changes: 2 additions & 2 deletions .github/ReleasePlanning.md → docs/ReleasePlanning.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Throughout the year we add issues to the `Backlog` milestone as is pointed out in our [Triage Process](https://github.com/dotnet/maui/blob/main/.github/TriageProcess.md).
Throughout the year we add issues to the `Backlog` milestone as is pointed out in our [Triage Process](TriageProcess.md).
We review all the issues in that milestone once a year, after the work on an upcoming major release is complete.
Given the large number of issues, it takes multiple sessions for teams to review and identify candidates for consideration for the next major release.
This document details the process we use for identifying candidate issues for the next release.
Expand All @@ -20,7 +20,7 @@ The issues which engineers think are good candidates and fit in the above listed
### Rough costing
At this phase engineers apply rough cost estimates to the final list of issues that they have moved to the `.NET V Planning` milestone, by applying one of the `Cost: X` labels below, where `X` is the size:

| **null** | **Description** |
| **Label** | **Description** |
|--------------|---------------------------------------------------|
| **Cost: S** | Work that requires one engineer up to 1 week |
| **Cost: M** | Work that requires one engineer up to 2 weeks |
Expand Down
4 changes: 2 additions & 2 deletions .github/TriageProcess.md → docs/TriageProcess.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ For some feature requests and bug reports, depending on the user involvement, we
Once we approach to the end of the release cycle (.NET Core 3, .NET 5) we will look through the accumulated issues in the `Backlog` milestone. This is a long process as the amount of issues accumulated in this milestone is quite large.

We will try to prioritize issues with most community requests / upvotes assuming these are aligned with our goals.
Issues, which we will think are candidates for the upcoming release, will be moved to the `.NET V Planning` (where V is the .NET version we're planning this for) milestone. This process is documented in more details in the [Release Planning](https://github.com/dotnet/maui/blob/main/.github/ReleasePlanning.md) document.
Issues, which we will think are candidates for the upcoming release, will be moved to the `.NET V Planning` (where V is the .NET version we're planning this for) milestone. This process is documented in more details in the [Release Planning](ReleasePlanning.md) document.

## Cleanup
As we go through all the issues in the Backlog milestone as part of our release planning process, we will also cleanup the milestone by closing low priority issues, which have stayed in the backlog for more than 2 releases. While some of these issues may seem reasonable, the fact that those haven't been addressed for such prolonged period of time indicate that they're not as important for the product as they may seem to be.
Expand All @@ -94,4 +94,4 @@ graph TD

## References

We rely on some automation to help us with this process. You can learn more about some of these by reading our [Issue Management Policies](https://github.com/dotnet/maui/blob/main/.github/IssueManagementPolicies.md) document.
We rely on some automation to help us with this process. You can learn more about some of these by reading our [Issue Management Policies](IssueManagementPolicies.md) document.

0 comments on commit b82e840

Please sign in to comment.