below are common sections that you may like to populate or leave empty to populate later. refer to the template repo WesternDeveloperSociety/project-spec-template for the default.
what and who is this project for?
add instructions on how to contribute to this repository, below is an example
-
Create a branch off of
devbranch named in the format<name>/type-title-of-this-branch.- valid types include:
- feat: feature
- fix: bug fix
- refact: refactor
- docs: documentation
- chore: a chore
- valid types include:
-
Once development is concluded, open a pull request from your branch back to the
devbranch.
dev: where contributions are madeqa: contains a functional version of code to be testedprod: production ready code to be released
add instructions on how to start the dev environment, below is an example
- Install dependencies
npm i- Start development server
npm run devadd instructions on how to deploy this project (in applicable), below is an example
- Ensure
NODE_ENV=production
echo "NODE_ENV=production" > .env- Install production dependencies
npm i- Start production server
npm run startgive yourself some credit
Team Leads:
- Derek
- Ben
Developers:
- Jenusan
- Jason
- Rohan
- Aaryan
- Jasper
- Raj
- Issar