first draft of contributing document: style/format
This commit is contained in:
Vendored
+1
@@ -4,6 +4,7 @@
|
||||
"dbaeumer.vscode-eslint",
|
||||
"esbenp.prettier-vscode",
|
||||
"monosans.djlint",
|
||||
"DavidAnson.vscode-markdownlint",
|
||||
"EditorConfig.EditorConfig"
|
||||
],
|
||||
"unwantedRecommendations": []
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# Contributing
|
||||
|
||||
## Code Style and Format
|
||||
|
||||
**If you don't already know what a formatter and linter are, read the following guide, the sections "Formatters" and "Linters", especially: [Formatters, linters, and compilers: Oh my!](https://github.com/readme/guides/formatters-linters-compilers)**
|
||||
|
||||
### Formatters
|
||||
|
||||
- JavaScript, JSON, CSS: [Prettier](https://prettier.io/docs/install)
|
||||
- Handlebars: [DJLint](https://djlint.com/docs/getting-started/)
|
||||
|
||||
### Linters
|
||||
|
||||
- JavaScript: [Eslint](https://eslint.org/docs/latest/use/getting-started)
|
||||
- Markdown: [Markdownlint](https://github.com/markdownlint/markdownlint)
|
||||
- Handlebars: [DJLint](https://djlint.com/docs/getting-started/)
|
||||
- CSS: VSCode Built-in
|
||||
|
||||
### Misc
|
||||
|
||||
- [EditorConfig](https://editorconfig.org/) - Used to standardize file configurations like tabs vs. spaces, end-of-line characters, etc.
|
||||
|
||||
### VSCode Extensions
|
||||
|
||||
These extensions will be auto-recommended to install. If you do not use VSCode, there are likely integrations with your code editor.
|
||||
|
||||
- [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||
- [esbenp.prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
||||
- [monosans.djlint](https://marketplace.visualstudio.com/items?itemName=monosans.djlint)
|
||||
- [DavidAnson.vscode-markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
||||
- [EditorConfig.EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
||||
|
||||
## Localization
|
||||
Reference in New Issue
Block a user