https://github.com/microcodeincorporated/javascriptsg
MicroCODE's JavaScript Style Guide
https://github.com/microcodeincorporated/javascriptsg
Last synced: 4 months ago
JSON representation
MicroCODE's JavaScript Style Guide
- Host: GitHub
- URL: https://github.com/microcodeincorporated/javascriptsg
- Owner: MicroCODEIncorporated
- License: mit
- Created: 2022-03-04T15:24:05.000Z (over 4 years ago)
- Default Branch: Production
- Last Pushed: 2024-07-11T13:13:46.000Z (almost 2 years ago)
- Last Synced: 2025-11-09T10:03:20.371Z (7 months ago)
- Size: 24.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaScript Style Guide
MicroCODE's JavaScript Style Guide.
## Description
This Javascript (.JS) Style Guide used by all coders involved in a MicroCODE project.
This defines our documentation rules, code style rules, and code ordering rules.
## Getting Started
### Dependencies
* This Style Guide was started from the MIT xPRO Style Guide.
* The MIT xPRO Style Guide was created from the AirBnb JavaScript Style Guide.
* We have taken those guides and applied our experience from 30 years to make it our own.
### Installing
* This is just a PDF to read, but be sure to use it in conjunction with our JavaScript Code Templates.
```
mcodeTemplate.html
componentTemplate.js
moduleTemplate.js
classTemplate.js
```
## Help
If there is anyting you do not understand about using this guide (along with our templates) get with other team members. Do NOT make assumptions about it use.
## Terminology
| Word or Acronym | Description/Definition |
|-------------------|-------------------------------------------------------|
| Template | A file used to start others to ensure code and documentation consistency.
| ES5, ES6 | Different revisions of the JavaScript (ECMAScript) language standard.
| JavaScriptSG | MicroCODE's JavaScript Style Guide. (Available on GitHub).
## Authors
Contributors names and contact info
* Timothy J McGuire [@TimothyMcGuire](https://twitter.com/TimothyMcGuire)
## Version History
* 0.8 - Updated various sections and added more notes about JSDocs usage
* 0.7 - Added JSDocs information
* 0.6 - Added notes about FIRA Font
* 0.5 - Added notes about A.I. assisting with consistent code
* 0.4 - Fat Arrow Functions
* 0.3 - Corrections and explanations
* 0.2 - Example pictures of code
* 0.1 - Monospaced Font examples and recommendations, CAESAR 'Hail Caesar!' statements.
* 0.0 - Initial Release
## License
This project is licensed under the MIT License - see the LICENSE.md file for details
## Acknowledgments
Inspiration, code snippets, etc.
* [AirBnb's JS StyleGuide](https://github.com/airbnb/javascript)