Project Name

BigCommerce Storefront Theme

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation and Setup Guide
3. Roadmap
4. Contributing
5. Stack

About The Project

Project name description.

(back to top)

Installation and Setup Guide

Dawn 7+

• Run husky setup: npx husky install
• Install the theme dependencies: npm install

Code Owners

• Define who is the code owner of the project. Sometimes the code owner is the project lead or maybe the team lead of your team, this info can find it in the Jira project, learn more about code owners.

CSS

• Add the code below to the end of the file /assets/scss/theme.scss.

JavaScript

Templates Structure

(back to top)

Roadmap

Project roadmap planning, accomplishments and releases.

• Project goal 1
• Project goal 2
• Project goal 3

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, create a pull request. You can also simply open an issue with the tag "enhancement".

• Create your Feature Branch (git checkout -b feature/JIRA-ID)
• Commit your Changes (git commit -m 'feat: JIRA-ID feature description')
• Push to the Branch (git push origin feature/JIRA-ID)
• Open a Pull Request (assign yourself to the PR, and add the Code Reviewer)
• Follow the project Pull Request Guidelines

(back to top)

Stack

• Node.js 14+
• ESLint
• Stylelint
• CommitLint (Conventional Commits)
• Cypress (E2E Test)
• Husky (Git Hooks)
• Editorconfig
• GitHub Actions
• GitHub Code Owners

(back to top)