diff --git a/README.md b/README.md index a8a9f65..4c19576 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,79 @@ The website is located at [BajaUofC.com](https://www.youtube.com/watch?v=dQw4w9WgXcQ) +# How to Commit +``` +(scope or file that has been changed): short description +``` +! for any breaking commits +### 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 + +### 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 + +# 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 + * @param {number} b - one argument into the function should be its name + * @returns {Promise} c - what the program returns with type + * @description A brief description of what the function does + * @author Name +//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 + return 0; //example function does nothing significant +} + +/** + * @param {Object} inputVar - one argument into the function should be its name + * @param {number} b - one argument into the function should be its name + * @returns {Promise} c - what the program returns with type + * @description A brief description of what the function does + * @author Name +//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 + return 0; //example function does nothing significant +} +``` + # Getting Started with Create React App This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).