Skip to content

Commit

Permalink
fixed typos!
Browse files Browse the repository at this point in the history
  • Loading branch information
buffet-time committed Sep 19, 2023
1 parent ff741e3 commit 7a116da
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
1 change: 1 addition & 0 deletions .vscode/spellright.dict
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pinkus
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions FILESTRUCTURE.md
Original file line number Diff line number Diff line change
@@ -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 `<style>`. This means that we try not to use Tailwind's classes directly in a file's `<template>`. Rather, we make a class name, and in the file's `<style>`, call `@apply` on top of any extra styling.

Expand Down Expand Up @@ -26,7 +26,7 @@ More information about the usage of this directory in [the documentation](https:

### `i18n`

`i18n` (short for internationalizaion), is where we'll be storing our locales for translating this site into different languages.
`i18n` (short for internationalization), is where we'll be storing our locales for translating this site into different languages.

### `layouts`

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you'd like to start contributing to the project please check [`CONTRIBUTING.m

## VSCode Setup

- Install the reccomended extensions
- Install the recommended extensions

- These come from `/.vscode/extensions.json`
- They will also appear in the extensions tab in the recommended dropdown alongside some automatically suggested extensions from VSCode itself.
Expand Down Expand Up @@ -65,7 +65,7 @@ Checkout the [deployment documentation](https://v3.nuxtjs.org/guide/deploy/prese

## Development Environment

If you're using VSCode (which we highly reccomend) please install the 6 extensions that we have in our `extensions.json` file. This in the extensions section then shows you ESLint, Prettier, Vetur, NPM Intellisense, TailwindCSS IntelliSense, PostCSS Language Support, etc. This will allow you to have proper automatic Linting, Formatting, and more with no extra setup!
If you're using VSCode (which we highly recommend) please install the 6 extensions that we have in our `extensions.json` file. This in the extensions section then shows you ESLint, Prettier, Vetur, NPM Intellisense, TailwindCSS IntelliSense, PostCSS Language Support, etc. This will allow you to have proper automatic linting, formatting, and more with no extra setup!

## Vue File Structure

Expand Down

0 comments on commit 7a116da

Please sign in to comment.