Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a template for discussing a settings change #8376

Merged
merged 4 commits into from
Dec 1, 2020
Merged

Add a template for discussing a settings change #8376

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e02dbe1
Add a template for discussing a settings change
zadjii-msft Nov 23, 2020
d30a16c
a small note
zadjii-msft Nov 23, 2020
1a82e02
That small note should really live here
zadjii-msft Nov 23, 2020
4a73c52
Maybe this makes more sense
zadjii-msft Nov 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions doc/specs/settings-spec-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
author: <first-name> <last-name> <github-id>/<email>
created on: <yyyy-mm-dd>
last updated: <yyyy-mm-dd>
issue id: <github issue id>
---

[comment]: # Use this template for proposing a new setting, or new values for an existing setting

# Spec Title

## Abstract

[comment]: # Outline what this spec describes.

## Background

### Inspiration

[comment]: # Are there existing precedents for this type of configuration? These may be in the Terminal, or in other applications

### User Stories

[comment]: # List off the use cases where two users might want a feature to have different behavior based on user preference. Include links to issues that might be relevant.

### Future Considerations

[comment]: # Are there other future features planned that might affect the current design of this setting? The team can help with this section during the review.

## Solution Design

[comment]: # Add notes that might be relevant to the proposed solutions.

[comment]: # Also, outline various different proposed designs for this setting. These won't all be winners, but may help during the decision making process. For each proposed design:

### Proposal 1: <name of proposal>

[comment]: # Describe the values for the properties, how it'll be exposed in both JSON and the Settings UI, and list pros and cons for this design. If there are technical details for this proposal, include them here.

* **Pros**:
* **Cons**:

## Conclusion

[comment]: # Of the above proposals, which should we decide on, and why?


## UI/UX Design

[comment]: # How will different values of this setting affect the end user?

## Potential Issues

<table>

<tr>
<td><strong>Compatibility</strong></td>
<td>

[comment]: # Will the proposed change break existing code/behaviors? If so, how, and is the breaking change "worth it"?

</td>
</tr>
</table>

[comment]: # If there are any other potential issues, make sure to include them here.


## Resources

[comment]: # Be sure to add links to references, resources, footnotes, etc.


### Footnotes

<a name="footnote-1"><a>[1]: