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

68
README.md
View File

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