Ucalgary_Baja/BajaUofCWebsite
4
0
Fork 0
mirror of https://github.com/UofCBaja/BajaUofCWebsite.git synced 2025-06-16 13:54:17 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): fixed wording of commits that break things

Browse Source
This commit is contained in:
darkicewolf50 2024-09-21 14:10:04 -06:00
parent 1ef784d162
commit 286645e13e
1 changed files with 36 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -5,46 +5,50 @@
The website is located at [BajaUofC.com](https://www.youtube.com/watch?v=dQw4w9WgXcQ)
# How to Commit
```
<type>(scope or file that has been changed): short description
```
! for any breaking commits
! for any commits that break a component or system
### Example
```
feat(api)!: send an email to the customer when a product is shipped
```
### Type
Must be one of the following:
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
* **docs**: Documentation only changes
* **feat**: A new feature
* **fix**: A bug fix
* **perf**: A code change that improves performance
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* **test**: Adding missing tests or correcting existing tests
* **chore**:
* **added**: Added content but not a complete feature
* **removed**: Removed files or content only
* **merged**: Used when a branch's content is merged into another branch
- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- **docs**: Documentation only changes
- **feat**: A new feature
- **fix**: A bug fix
- **perf**: A code change that improves performance
- **refactor**: A code change that neither fixes a bug nor adds a feature
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- **test**: Adding missing tests or correcting existing tests
- **chore**:
- **added**: Added content but not a complete feature
- **removed**: Removed files or content only
- **merged**: Used when a branch's content is merged into another branch
### Subject
The subject contains a succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize the first letter
* no dot (.) at the end
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
# Starting JS templates
Uses [JSDocs](https://jsdoc.app), gives a good way to describe what a function does and needs
```js
//More prefered arrow function just need to call function and does function immediately
/**
* @param {Object} inputVar - one argument into the function should be its name
@ -55,11 +59,11 @@ Uses [JSDocs](https://jsdoc.app), gives a good way to describe what a function d
//semi-perminant email, do not need to respond but try to be a good alumni
*/
const exampleFunct = (inputVar) => {
const varExample0 = 0 //constant variable cannot change, not strongly typed
let varExample1 = 0 //local varialbe, not strongly typed can be any data type
var varExample2 = 0 //global variable, not strongly typed can be any data type
const varExample0 = 0; //constant variable cannot change, not strongly typed
let varExample1 = 0; //local varialbe, not strongly typed can be any data type
var varExample2 = 0; //global variable, not strongly typed can be any data type
return 0; //example function does nothing significant
}
};
/**
* @param {Object} inputVar - one argument into the function should be its name
@ -70,9 +74,9 @@ const exampleFunct = (inputVar) => {
//semi-perminant email, do not need to respond but try to be a good alumni
*/
function exampleFunct2(inputVar) {
const varExample0 = 0 //constant variable cannot change, not strongly typed
let varExample1 = 0 //local varialbe, not strongly typed can be any data type
var varExample2 = 0 //global variable, not strongly typed can be any data type
const varExample0 = 0; //constant variable cannot change, not strongly typed
let varExample1 = 0; //local varialbe, not strongly typed can be any data type
var varExample2 = 0; //global variable, not strongly typed can be any data type
return 0; //example function does nothing significant
}
```