Shopify-starter-kit is an open-source project built for the Shopify Theme community, and it needs contributions from the community to be truly successful. We encourage you to join us in our mission of enhancing the Shopify theme development experience!
The Shopify-starter-kit Github repo exists for the theme development community to discuss and solve problems. It is not the place to discuss general theme development problems.
If you encounter a bug, think of a useful feature, or find something confusing in the docs, please create a new issue!
We ❤️ pull requests. If you'd like to fix a bug, contribute to a feature or just correct a typo, please feel free to do so, as long as you follow our Code of Conduct.
If you're thinking of adding a big new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the project (and potentially save yourself some time!).
To start working on the codebase:
git clone [email protected]:spiral/shopify-starter-kit.git
yarn install
This command will install project dependencies and make sure any references to packages use the local versions of those packages instead of the version hosted on NPM.
yarn test
git commit -a -m="[#{{ISSUE-NUMBER}}] Your commit message"
NOTE: {{ISSUE-NUMBER}} is the number of you issue (#2, #54)
git push origin master
See Github's official documentation for more details.
If your change affects how people use the project (i.e. adding or removing functionality, changing the return value of a function, etc), please ensure the documentation website is also updated to reflect this.
The documentation website lives in the readme file.