Skip to content

Add TOC, Scaffolding to tech vision doc #166

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

Merged
merged 2 commits into from
May 23, 2019
Merged

Add TOC, Scaffolding to tech vision doc #166

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee3e25f
Add TOC, Scaffolding to tech vision doc
May 22, 2019
2d7d742
Address CR feedback
May 23, 2019
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
18 changes: 18 additions & 0 deletions design-documents/frontend/technical-vision.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ The following document is a guide for all _future_ Magento front-end application
- Productivity (Efficiency)
- Quality (Reliability)

## Table of Contents

- [React](#react)
- [TypeScript](#typescript)
- [Portability](#portability)
- [Browser Support](#browser-support)
- [React UI Component Library](#react-ui-component-library)
- [Styles](#styles)
- [Accessibility](#accessibility)
- [Code Quality](#code-quality)
- [Testing](#testing)
- [Scaffolding](#scaffolding)

## [React][]

_Portability, Performance, Productivity, Quality, Internationalization._
Expand Down Expand Up @@ -181,9 +194,14 @@ _Disclaimer: the above list is not exhaustive and is in no particular order._

Ideally, for each front-end project, there will be a separate project that covers both performance and critical-path testing. This project is separate so that it doesn't cripple the short feedback loops of feature development. Additionally, we would do well to have additional performance testing around the most commonly used components (e.g., used in 3+ places).

## Scaffolding

[Yeoman][] is a tool for scaffolding modern web applications. In an effort to make the above guide as painless as possible and to encourage best practices, a [TSX Yeoman Generator](https://www.npmjs.com/package/generator-tsx) has been created for you. Refer to its documentation for more information.

[CRA]: https://facebook.github.io/create-react-app/
[Jest]: https://jestjs.io/
[Prettier]: https://prettier.io/
[React]: https://reactjs.org/
[TSLint]: https://palantir.github.io/tslint/
[Typescript]: http://www.typescriptlang.org/
[Yeoman]: https://yeoman.io/