terminal/doc/specs/spec-template.md
Rich Turner 16c32a622e
Docs: Contributor's guide and spec-template (#967)
Submitting first draft of spec template, and `contributing.md` outlining our guidance on how to engage with us, file issues, suggest features, submit changes, etc.
2019-06-05 13:54:21 -07:00

1.6 KiB

author created on last updated issue id
<first-name> <last-name> <github-id>/<email> <yyyy-mm-dd> <yyyy-mm-dd> <github issue id>

Spec Title

Abstract

[comment]: # Outline what this spec describes

Inspiration

[comment]: # What were the drivers/inspiration behind the creation of this spec.

Solution Design

[comment]: # Outline the design of the solution. Feel free to include ASCII-art diagrams, etc.

UI/UX Design

[comment]: # What will this fix/feature look like? How will it affect the end user?

Capabilities

[comment]: # Discuss how the proposed fixes/features impact the following key considerations:

Accessibility

[comment]: # How will the proposed change impact accessibility for users of screen readers, assistive input devices, etc.

Security

[comment]: # How will the proposed change impact security?

Reliability

[comment]: # Will the proposed change improve reliabilty? If not, why make the change?

Compatibility

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

Performance, Power, and Efficiency

Potential Issues

[comment]: # What are some of the things that might cause problems with the fixes/features proposed? Consider how the user might be negatively impacted.

Future considerations

[comment]: # What are some of the things that the fixes/features might unlock in the future? Does the implementation of this spec enable scenarios?

Resources

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