git clone https://github.com/malewis5/commerce2.1.git
npm install
Step 3: Install Vercel CLI
npm i -g vercel
- Configure the Vercel CLI
vercel login
- Follow the prompts to login with your credentials
- This command links your project with the remote Vercel project
vercel link
- This command pulls env variables from the project you linked. You can view them in the
.envfile created
vercel env pull
npm run dev
This project follows a CI/CD strategy that is outlined below. Please follow this strategy as it will be enforced. We enforce conventional commits and use release-please to generate release notes and changelog.
- Create your feature branch from main
git checkout -b <ticket-number>-<description (optional)>. - Write and test your code.
- When you're ready to commit, use the following convention for your commit message:
<type>[optional scope]: <description> [optional body] [optional footer]
| Type | Use Case |
|---|---|
| fix | patches a bug in your codebase and correlates with the patch version in semantic versioning |
| feat | introduces a new feature to the codebase and correlates with a minor version in semantic versioning |
| BREAKING CHANGE! | introduces a breaking API change and correlates with a major version in semantic versioning. A breaking change can be part of commits of any type indicated by a exclamation (!) e.g., a fix!: and feat!: types would be valid, in addition to any other type. |
| build | Changes that affect the build system or external dependencies (example scopes: npm packages) |
| ci | Changes to our CI configuration files and scripts |
| docs | Documentation only changes |
| 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 |
This table is also available in the commit-template.md file
FOLLOWING THIS FORMAT IS CRITICAL FOR OUR RELEASE NOTES AND CHANGELOG
- This will create a preview deployment in Vercel where QA and UAT tasks will be completed. When the deployment is successful, the URL will be automatically added to the JIRA deployment on the ticket.