Skip to content

Commit

Permalink
Add Templates, Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brminnick committed Sep 23, 2021
1 parent f377ec5 commit 8cd5f4c
Show file tree
Hide file tree
Showing 7 changed files with 141 additions and 127 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,31 @@
---
name: Bug Report
about: Create a report to help us improve
about: Report a bug in the .NET MAUI Markup Toolkit
title: "[Bug] "
labels: 'bug, s/unverified'
labels: bug, unverified
assignees: ''

---

<!--
Hello, and thanks for your interest in contributing to the .NET MAUI Markup Toolkit!
Please describe the issue below, including detailed steps for reproduction. If we are unable to reproduce the bug we will be unable to fix the issue and may close this Issue.
-->

### Description

<!-- Please provide a detailed description of the issue -->

### Stack Trace

<!-- Please copy/paste the complete stack trace (if applicable) -->

### Link to Reproduction Sample

<!-- Please link to a GitHub Repo or GitHub Page -->

### Steps to Reproduce

1.
Expand Down Expand Up @@ -38,7 +55,3 @@ assignees: ''
### Reproduction imagery

<!-- If it is a visual issue, please include imagery (GIF/Screenshots) showing the problem -->

### Reproduction Link

<!-- Please upload or provide a link to a reproduction case -->
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: Propose a New Feature or Ask a Question
url: https://github.com/communitytoolkit/maui.markup/discussions/new
about: Starting a discussion is the first step in creating a new feature proposal

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/new-api-spec.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/open-a-new-feature-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Open a New Feature Proposal
about: For proposals that have been discussed in the Discussions tab and have been approved by a member of the core .NET MAUI Toolkit team
title: "[Proposal] "
labels: new, proposal
assignees: ''

---

<!--
Hello, and thanks for your interest in contributing to the .NET MAUI Toolkit!
If you haven't been invited by a team member to open an Proposal, please instead open a Discussion at https://github.com/communitytoolkit/maui.markup/discussions/new where we can discuss the pros/cons of the feature and its implementation.
New language feature proposals should fully fill out this template. This should include a complete detailed design, which describes the syntax of the feature, what that syntax means, and how it affects current parts of the spec. Please make sure to point out specific spec sections that need to be updated for this feature.
-->
# [FEATURE_NAME]

* [x] Proposed
* [ ] Prototype: Not Started
* [ ] Implementation: Not Started
* [ ] Documentation: Not Started
* [ ] Sample: Not Started

## Link to Discussion

<!-- Please link to the completed/approved [Discussion](https://github.com/communitytoolkit/maui/discussions)-->

## Summary
[summary]: #summary

<!-- One paragraph explanation of the feature. -->

## Motivation
[motivation]: #motivation

<!-- Why are we doing this? Which use cases does it enable? What is the expected outcome? -->

## Detailed Design
[design]: #detailed-design

<!-- This is the bulk of the proposal. Explain the design in enough detail for somebody familiar with .NET MAUI to understand, and for somebody familiar with the Community Toolkit to implement, and include examples of how the feature is used. Please include syntax and desired semantics for the change, including linking to the relevant parts of the existing .NET MAUI Toolkit spec to describe the changes necessary to implement this feature. An initial proposal does not need to cover all cases, but it should have enough detail to enable a community member to bring this proposal to design if they so choose. -->

## Drawbacks
[drawbacks]: #drawbacks

<!-- Why should we *not* do this? -->

## Alternatives
[alternatives]: #alternatives

<!-- What other designs have been considered? What is the impact of not doing this? -->

## Unresolved Questions
[unresolved]: #unresolved-questions

<!-- What parts of the design are still undecided? -->
56 changes: 12 additions & 44 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,20 @@
<!--
Hey there friend! First of all, thank you so much for this PR!
<!--
Hello, and thanks for your interest in contributing to the .NET MAUI Toolkit!
Before doing a lot of work, please check if there's an open issue for this change and that it has been approved by one of our maintainers.
For Bug Fixes:
If you haven't yet opened an Issue that reports the bug in detail, provides a reproduction sample, and has been verified + reproduced by a member of the .NET MAUI Toolkit core team, please do that before submitting a Pull Request. Bug Fix Pull Requests without an associated Issue will be closed.
If not, please open an issue first so we can discuss upfront.
For New Feature Proposals:
If you haven't yet submitted a Proposal that has been Championed by a .NET MAUI core team member, please instead open a Discussion at https://github.com/communitytoolkit/maui/discussions/new where we can discuss the pros/cons of the feature and its implementation.
-->

### Description of Change ###
## Fixes
<!-- Please link to the Issue that this Pull Request resolves -->

<!-- Describe your changes here. -->
## Description

### Bugs Fixed ###
<!-- Provide links to issues here. Ensure that a GitHub issue was created for your feature or bug fix before sending PR. -->
<!-- Please copy/paste the Description/Summary from your Issue-->

- Fixes #
## Detailed Solution

### API Changes ###

<!-- List all API changes here (or just put None), example:
Added:
- `string Class.Property { get; set; }`
- `void Class.Method();`
Changed:
- `object Cell.OldPropertyName` => `object Cell.NewPropertyName`
If there is an entirely new API, then you can use a more verbose style:
```csharp
public static class NewClass {
public static int SomeProperty { get; set; }
public static void SomeMethod(string value);
}
``` -->

### Behavioral Changes ###

<!-- Describe any non-bug related behavioral changes that may change how users app behaves when upgrading to this version of the codebase. -->

### PR Checklist ###
<!-- Please check all the things you did here and double-check that you got it all, or state why you didn't do something -->
- [ ] Has a linked Issue, and the Issue has been `approved`
- [ ] Has tests (if omitted, state reason in description)
- [ ] Has samples (if omitted, state reason in description)
- [ ] Rebased on top of main at time of PR
- [ ] Changes adhere to coding standard
<!-- If at all possible, please update/add the documentation on the repo below. We would very much appreciate that. If you are unable to, please consider at least opening an issue on the repo below so we know that Docs still need to be adjusted/created. Thanks! <3 -->
- [ ] Updated Documentation
<!-- Please describe the solution in detail-->
52 changes: 47 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,55 @@

[<img src="https://raw.githubusercontent.com/dotnet-foundation/swag/master/logo/dotnetfoundation_v4.svg" alt=".NET Foundation" width=100>](https://dotnetfoundation.org)

.NET MAUI Markup Community Toolkit
===========
Members of the community are rebooting this library under the guidance of the .NET MAUI team. The .NET MAUI Community Toolkit is a collection of common elements for development with .NET MAUI that people tend to replicate across multiple apps. It simplifies and demonstrates common developer tasks when building apps with .NET MAUI.
# .NET MAUI Markup Community Toolkit

The .NET MAUI Markup Community Toolkit is a collection of Fluent C# Extension Methods that allows developers to continue architecting their apps using MVVM, Bindings, Resource Dictionaries, etc., without the need for XAML

All features are contributed by you, our amazing .NET community, and maintained by a core set of maintainers.

And – the best part – the features you add to the .NET MAUI Toolkit may one day be included into the official .NET MAUI library! We leverage the Community Toolkits to debut new features and work closely with the .NET MAUI engineering team to nominate features for promotion.

## Submitting A New Feature

New features will follow the following steps:

### 1. Discussion Started

Debate pertaining to new Maui Toolkit features takes place in the form of [Discussions](https://github.com/communitytoolkit/maui.markup/discussions) in this repo.

If you want to suggest a feature, discuss current design notes or proposals, etc., please [open a new Discussion topic](https://github.com/communitytoolkit/maui.markup/discussions/new).

Discussions that are short and stay on topic are much more likely to be read. If you leave comment number fifty, chances are that only a few people will read it. To make discussions easier to navigate and benefit from, please observe a few rules of thumb:

- Discussion should be relevant to the .NET MAUI Toolkit. If they are not, they will be summarily closed.
- Choose a descriptive topic that clearly communicates the scope of discussion.
- Stick to the topic of the discussion. If a comment is tangential, or goes into detail on a subtopic, start a new discussion and link back.
- Is your comment useful for others to read, or can it be adequately expressed with an emoji reaction to an existing comment?

### 2. Proposal Submitted
Once you have a fully fleshed out proposal describing a new feature in syntactic and semantic detail, please [open an issue for it](https://github.com/communitytoolkit/maui.markup/issues/new/choose), and it will be labeled as a [Proposal](https://github.com/communitytoolkit/maui.markup/issues?q=is%3Aopen+is%3Aissue+label%3Aproposal). The comment thread on the issue can be used to hash out or briefly discuss details of the proposal, as well as pros and cons of adopting it into the .NET MAUI Toolkit. If an issue does not meet the bar of being a full proposal, we may move it to a discussion, so that it can be further matured. Specific open issues or more expansive discussion with a proposal will often warrant opening a side discussion rather than cluttering the comment section on the issue.

### 3. Proposal Championed
When a member of the .NET MAUI Toolkit core team finds that a proposal merits promotion into the Toolkit, they can [Champion](https://github.com/communitytoolkit/maui.markup/issues?q=is%3Aopen+is%3Aissue+label%3A%22proposal+champion%22) it, which means that they will bring it to the monthly [.NET MAUI Toolkit Community Standup](https://www.youtube.com/watch?v=0ZBh2Hl54ZY).

### 4. Proposal Approved
The .NET MAUI Toolkit core team will collectively vote to work on adopting and/or modifying the proposal, requiring a majority approval (i.e. greater than 50%) to be added to the Toolkit.

Once a Proposal has been championed and has received a majority approval from the .NET MAUI Toolkit core team, a Pull Request can be opened.

### 5. Pull Request Approved
After a Pull Request has been submitted, it will be reviewed and approved by the Proposal Champion.

Every new feature also requires an associated sample to be added to the .NET MAUI Toolkit Sample app.

### 6. Documentation Complete
Before a Pull Request can be merged into the .NET MAUI Toolkit, the Pull Request Author must also submit the documentation to [Add link to Microsoft Docs GitHub Repo Here].

### 7. Merged
Once a Pull Request has been reviewed + approved AND the documentation has been written, submitted and approved, the new feature will be merged adding it to the .NET MAUI Toolkit

## Code of Conduct
As a part of the .NET Foundation, we have adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). Please familiarize yourself with that before participating with this repository. Thanks!

## .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).

This project is supported by the [.NET Foundation](https://dotnetfoundation.org).

0 comments on commit 8cd5f4c

Please sign in to comment.