diff --git a/.vscode/settings.json b/.vscode/settings.json index 0610051a..f332cab8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -31,5 +31,6 @@ "volar.takeOverMode.enabled": true, "volar.icon.preview": true, "volar.autoCompleteRefs": true, - "typescript.tsdk": "node_modules/typescript/lib" + "typescript.tsdk": "node_modules/typescript/lib", + "cSpell.enableFiletypes": ["!html", "!jade", "!java", "!json", "!jsonc"] } diff --git a/.vscode/spellright.dict b/.vscode/spellright.dict new file mode 100644 index 00000000..c8dabdc9 --- /dev/null +++ b/.vscode/spellright.dict @@ -0,0 +1 @@ +pinkus diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fac3db5..39af3b14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ Filing issues is as simple as going to [the issue tracker](https://github.com/le ### Example code contribution flow 1. Make a fork of this repo. -1. Name a branch on your fork something descriptive for this change (eg. `UpdateNavbarStyles`). +1. Name a branch on your fork something descriptive for this change (e.g. `UpdateNavbarStyles`). 1. Commit your changes (Tip! Please read our [Style guide](#style-guide) to help the pull request process go smoothly). 1. Verify your changes work. 1. Push your branch. @@ -42,7 +42,7 @@ Filing issues is as simple as going to [the issue tracker](https://github.com/le - Be descriptive, it can be hard to understand abbreviations or short-hand. - prefer `catch(error)` over `catch(e)` - Make sure that your components are _responsive_. -- Two major philosphies we adhere to are KISS (keep it super simple) and DRY (don't repeat yourself) +- Two major philosophies we adhere to are KISS (keep it super simple) and DRY (don't repeat yourself) - In general try not to make your code too "clever" if it's possible to do it in a less "clever" way so that it's easily read by other contributors. ### Nuxt/Vue @@ -52,14 +52,14 @@ Filing issues is as simple as going to [the issue tracker](https://github.com/le - Make sure any data and prop names are as descriptive as possible. - Try to move any repetitive elements into child components to reduce clutter in parent components. - Prefer usage of `async/await` for asynchronous functions. - - only use Promise syntax for needed more advanced Async programminng that either can't be done or is harder to be done with `async/await` + - only use Promise syntax for needed more advanced Async programming that either can't be done or is harder to be done with `async/await` - Include proper error handling for any `async` functions. - Make all components compatible with server side rendering where possible. ### Git -- Try to have an informative branch name for others eg. `LBGG-{issue number}-{ghusername}`. +- Try to have an informative branch name for others e.g. `LBGG-{issue number}-{ghusername}`. - Do not make pull requests from `main`. - Do not include slashes in your branch name. - Nested paths can act strange when other people start looking at your branch. diff --git a/FILESTRUCTURE.md b/FILESTRUCTURE.md index 72bb35ec..421039ae 100644 --- a/FILESTRUCTURE.md +++ b/FILESTRUCTURE.md @@ -1,4 +1,4 @@ -# Vue File Structure +# Nuxt File Structure You'll find our Vue files in `components` and `pages`. The files are structured in the order: template, script, and style. One thing to note; we want to keep any and all styling in `