Highly Recommended to use VSCode because format settings are written in .vscode/settings.json.
git clone https://github.com/YukiOkamoto0206/social-chef.git
npm i
DO NOT commit your environmental variables like api key or database password. If you do not know .env file, let me know or check .sample.env file.
// Encourage you to use this, because this command is hot-reload with nodemon.
npm run dev
git checkout -b <new branch name>
git add 〇〇.js 〇〇.ejs
The commit message should be structured as follows:
Small commit makes us
- Easy to check pull request
- Easy to revert
- Less bugs
more details here
- feat : new feature
- fix : bug fix
git commit -m "feat: fetch the recipes api"
git push origin <branch name>
After you push your changes to your branch, create Pull Request in the GitHub. If you don't know how to use it, check here.
If somebody create a pull request or fix it, GitHub automatically send the message through the slack. The others can check it.
Do not change the branch before commiting or stashing your current branch.
// update new information from GitHub
$ git checkout main
$ git pull origin main
// change the branch that you want
$ git checkout <branch that you want to checkout>
// if somebody install new library, you need it.
$ npm i
// check whether it works or not
$ npm run dev
If you find something wrong, PLEASE comment in GitHub, if not, approve the pull request. If 3 of all(except for the person who create pull request) approve it, MEARGE the branch to main.
git stash -u
git stash list
git stash apply stash@{0}