- When facing any roadblocks ask for help ASAP to meet deadlines
- When there is a conflict we will vote among the 5 of us
- If a group member is not delivering obligations, we will give them warnings and then notify the stakeholders
- Respond to directed messages within a day
- Sprints are 1-2 weeks
- 3 standups of 15 mins: Tuesday evening, Thursday evening, Saturday morning
- Linter and code formatter: Eslint and prettier
- Code for each task and spike must be peer-reviewed and pass tests before merging into the main branch of code.
- Decentralized
- Always make a PR for a feature
- Never merge PR before at least one review has been made
- With each PR, please include a description of the changes:
- Which task/spike does the PR refer to (issue number)
- What changes have been made
- Review other open PRs if they are not yet reviewed
- Commit titles should be of the following format:
“Add feature”,“Change something”and etc. - Make sure you format the files before merging a PR by running
npm run formatandnpm run lint
- Installing Homebrew
- If you have not yet installed Brew, you will need to do that by referring to https://brew.sh/.
- Installing Git
- To install Git, type in your terminal: brew install git
- Downloading and Installing npm and Node.js
- To correctly install and download npm and Node.js, refer to this npm documentation page.
- Install Node dependencies
- To correctly install all node dependencies needed to run our project, type in your local terminal: npm install
- Downloading and Installing npm and Node.js
- To correctly install and download npm and Node.js, refer to this npm documentation page.
- Once the local environment is set up, you can start running the project. To run our front end, refer to our front end README.
- TBD