diff options
author | Dawson Botsford <dawsonbotsford@gmail.com> | 2017-09-20 15:09:54 -0700 |
---|---|---|
committer | Dawson Botsford <DawsonBotsford@gmail.com> | 2017-09-20 15:54:37 -0700 |
commit | d44e65eace24a28f47706b8f203b8ce44d622f74 (patch) | |
tree | fd798d35cc35e0fb977a694d82c9d2f0a2dfecad | |
download | best-practices-d44e65eace24a28f47706b8f203b8ce44d622f74.tar.gz best-practices-d44e65eace24a28f47706b8f203b8ce44d622f74.tar.bz2 best-practices-d44e65eace24a28f47706b8f203b8ce44d622f74.zip |
๐ init
-rw-r--r-- | LICENSE | 21 | ||||
-rw-r--r-- | readme.md | 55 |
2 files changed, 76 insertions, 0 deletions
@@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Driver + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..5b6912f --- /dev/null +++ b/readme.md @@ -0,0 +1,55 @@ +# Best Practices + +Make your code ๐ฏ - A collection of best practices for software + +## โ๏ธ JavaScript โ๏ธ + +* 2 spaces (instead of tabs) +* Lint with `eslint:recommended` at a minimum +* Promises (not callbacks) + +### โ๏ธ React/Redux โ๏ธ + +* Lint with [`tslint-react`](https://github.com/palantir/tslint-react) or eslint's [`plugin:react/recommended`](https://github.com/yannickcr/eslint-plugin-react) at a minimum. +* No unnecessary and empty `<div>`โs +* If `this.props.<variable name>` is used more than once, dereference it at the top of `render`. +* Extract variables used in `render()` to the top of `render()` +* API calls should lie in a testable file outside of components. + +* Components should not wait for promises to resolve, instead listen on props via reduxโ `mapStateToProps()`. +* Declare and export components in separate places (otherwise the web inspector cannot name components properly) + +### ๐ฃ๐ข TypeScript ๐ฃ๐ข + +* Lint with [`tslint:recommended`](https://github.com/palantir/tslint) at a minimum. +* No implicit any (type everything thatโs not inferable) +* Any variable declared without an initial value should be typed (`let patientId;`) +* In components which use `mapStateToProps`, separate `ownProps` from `connectedProps` into separate interfaces + +## ๐
CSS ๐
+ +* Prefer Flexbox +* Classes should describe elements and not be generic (`Bigbox` -> `FAQContainer`) +* Mobile: <= 620px +* Tablet: 620px - 1024px +* Desktop: > 1024px + +## HTML + +* Use `<button>` tags over `<a>` tags for actions. +* Use svg's over all other image formats when possible. +* All `<img>` tags should have `โaltโ` text. +* Only use tables for tabular data (not for layout) +* Make use of html5 elements like `<header>`, `<footer>`, `<nav>`, `<section>`, etc. + +## Npm + +* Support the following `script`'s in your root `package.json`: + +1. `โwatchโ`: Starts the dev server +2. `โbuildโ`: Builds static assets (if they exist) +4. `โtestโ`: Runs all tests (linting first, then unit tests) + +## ๐ธ Browsers ๐ธ + +* Avoid supporting versions of Internet Explorer before IE11. |