mirror of
https://github.com/XFox111/PasswordGeneratorExtension.git
synced 2026-04-22 08:08:01 +03:00
Updated Code style (markdown)
+4
-4
@@ -1,15 +1,15 @@
|
|||||||
This article contains a set of rules and guidelines that you should follow when working on an issue.
|
This article contains a set of rules and guidelines that you should follow when working on an issue.
|
||||||
|
|
||||||
There's not much rules here, but it is good to follow some of the key points:
|
There's not much rules here, but it is good to follow some of the key points:
|
||||||
- Indetation and spacing
|
- Indentation and spacing
|
||||||
- **Use tabs**, not spaces.
|
- **Use tabs**, not spaces.
|
||||||
- Use LF file separators (UNIX style).
|
- Use LF file separators (UNIX style).
|
||||||
- Separate logical blocks with empty lines
|
- Separate logical blocks with empty lines
|
||||||
- Separate block statements (if/else, try/catch, switch, etc.) with empty lines
|
- Separate block statements (if/else, try/catch, switch, etc.) with empty lines
|
||||||
- Always place opening braces on a new line
|
- Always place opening braces on a new line
|
||||||
- Always place conditional statement on the a new line
|
- Always place conditional statement on a new line
|
||||||
- Always make sure that there's no ESLint warnings.
|
- Always make sure that there's no ESLint warnings.
|
||||||
- Priorize readability over performance.
|
- Prioritize readability over performance.
|
||||||
- More comments is better.
|
- More comments is better.
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
@@ -19,5 +19,5 @@ There's not much rules here, but it is good to follow some of the key points:
|
|||||||
|
|
||||||
This project uses ESLint to maintain key aspects of the code style. It runs in following cases:
|
This project uses ESLint to maintain key aspects of the code style. It runs in following cases:
|
||||||
- Project build (fails build if critical issues are found)
|
- Project build (fails build if critical issues are found)
|
||||||
- Manual `npm run lint` command exectution
|
- Manual `npm run lint` command execution
|
||||||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension for VS Code is installed
|
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension for VS Code is installed
|
||||||
|
|||||||
Reference in New Issue
Block a user