Before getting started, you should read our article introducing the project: We're Building A Starter Theme For PrestaShop 1.7.8 and 8.
If you are contributing to this theme, you are probably interested in PrestaShop development as well. Please the following article to get familiar with PrestaShop branching model.
You got any questions ? Join the open source slack.
Join the slack at https://www.prestashop-project.org/slack/
There are few things to do before you are ready to contribute.
- Check your Git configuration. Read Set Up Your Git For Contributing
- Check your editor configuration. The rules are defined in
.editorconfig. Do it manually or install the available plugin. - Make sure you at least have NodeJS 14 installed.
- You should install the theme inside a PrestaShop instance, please refer to the developers docummentation of the project.
First you need to install every node module:
npm ci
then create a .env file inside the webpack folder by copying webpack/.env-example and complete it with your environment's informations. Please use a free tcp port.
then build assets:
npm run build
- Follow the BEM convention
- Be careful about creating SCSS files in the right folder, refer to the documentation for further informations.
- When you want to submit a PR, please make sure that you ran both linters using
npm run lint-fix && npm run scss-fixand fixed every lint issues. - If your PR is a work in progress, make sure that you use the Github draft mode.
- Fill the PR template as much as possible, it's important to speed the process of testing, reviewing...
- Try to organize your commits in a way to simplify the review.
Open an issue:
- To report a bug.
- To propose an improvement and get feedbacks before you code it. (example)