https://github.com/dtstack/code-style-guide
https://github.com/dtstack/code-style-guide
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dtstack/code-style-guide
- Owner: DTStack
- License: mit
- Created: 2021-11-29T12:56:53.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-14T10:18:29.000Z (over 3 years ago)
- Last Synced: 2024-02-25T12:37:34.916Z (over 1 year ago)
- Size: 89.8 KB
- Stars: 10
- Watchers: 18
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Code Style Guide
> Our project is based on the [airbnb](https://github.com/airbnb/javascript) and [TypeScript style guide](https://ts.dev/style/#identifiers) project fork to adapt the specification for the Dtstack Frontend Team.
> Compared to the original, it integrates the Dtstack Frontend Team specification, adds the latest JS and React features, and unit testing.
> We plan to sort out a set of corresponding link rules according to the specifications in the future and integrate them into our projects for actual production and development.
## Code Style guide directory
- [React](react/README.md)
- [CSS-in-JavaScript](css-in-javascript/README.md)
- [CSS & Sass](css-sass/README.md)
- [Javascript](javascript/README.md)
- [Typescript](typescript/README.md)
- [Unit-Test](unit-test/README.md)
## Why do need a code style guide
Because software is often written by different people throughout its life cycle. If everyone follows the specification, everyone's code style will be consistent.
## What can a code style guide do？
- Disciplined code promotes teamwork
- Regular code can reduce bug handling
- Regular code can reduce maintenance costs
- Normative code facilitates code review
- Getting into the habit of code specification helps programmers grow
## Thank you
Thanks for helping us as we sort through the code specification:
- [TypeScript style guide](https://ts.dev/style/#identifiers)
- [airbnb](https://github.com/airbnb/javascript)