Loving ScandiPWA and want to get involved? Thanks! There are plenty of ways you can help.
Please take a moment to review this document in order to make the contribution process straightforward and effective for everyone involved. We ask that you follow these guidelines make the time of the developers managing this open-source project more effective. Thank you for your time; we are looking forward to addressing your issue or assessing your patches and features!
Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and not contain unrelated commits.
Before starting development, please ask if somebody else is already working on this task. If you are developing a new feature, please make sure the core developers agree is in-scope of the ScandiPWA App.
You need to have Git, Node (version 10), and Yarn installed
git --versionnode -v # expected: v10.18.1 or similaryarn -v # expected: 1.18.0 or similar
You also need to fork the ScandiPWA repository to be able to create pull requests
Clone the ScandiPWA repository:
# clone your fork - replace <your-username> with your github usernamegit clone https://github.com/<your-username>/scandipwacd scandipwa # move into the directory you cloned
Install dependencies with
Start the development server:
cd packages/scandipwayarn start
The ScandiPWA repository is a monorepo, containing multiple packages in the
packages directory. This is managed by Lerna.
└── 📁 packages├── 📁 scandipwa # theme sources├── 📁 m2-theme # for building a magento2 theme├── 📁 bundle-analyzer├── 📁 router # the frontend routing mechanism└── 📁 framework
You can now make the changes you wish. Please remember to write meaningful commit messages.
In addition, before submitting a pull request, please verify that your code works as expected, and summarize your testing results in the description.
lerna publish command.
For canary publishing, use
lerna publish --canary --exact --preid next --dist-tag=next minor
When ready, push your commits to your fork, and create a pull request. Thanks for your contribution!