terminal/doc/specs/settings-spec-template.md

2.1 KiB

author created on last updated issue id
<first-name> <last-name> <github-id>/<email> <yyyy-mm-dd> <yyyy-mm-dd> <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:

[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

Compatibility

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

[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

[1]: