How to Contribute
Already a JS/Vue.js developer? Pick an issue, push a PR and instantly become a member of the vue-storefront contributors community. We've marked some issues as "Easy first pick" to make it easier for newcomers to begin!
Thank you for your interest in, and engagement!
Before you type an issue please check:
You should fork the project or create branch for new features. The main branches used by the core team are:
- master - where we store the stable release of the app (that can be deployed to our demo instances),
- develop - the most recent version of the app - kind of "nightly" build.
Please use "develop" for development purposes as the "master" can be merged just as the new release is coming out (about once a month)!
Issue reporting guidelines:
Always define type of issue:
- Bug report
- Feature request
While writing issues, be as specific as possible All requests regarding support with implementation or application setup should be sent to firstname.lastname@example.org
If the issue is about some changes with particular theme prefix the issue with theme name (ex. "[default] change product tile background color" )
We're introducing TypeScript to Vue Storefront core, so You can use it where it's aproprierate - but please be pragmatic. Here are some thoughts on how to use TS features in Vue Storefront: TypeScript Action Plan.
Pull request checklist
Here’s how to submit a pull request. Pull request that dont meet this requirements will not be merged.
ALWAYS use Pull Request template it's automatically added to each PR.
- Fork the repository and clone it locally fro the 'develop' branch. Make sure its up to date with current
- Create a branch for your edits. Use the following branch naming conventions:
- Describe what you've changed. Include screenshots of the new feature or the before and after if your changes include differences in HTML/CSS. Drag and drop the images into the body of your pull request.
- Reference any relevant issues or supporting documentation in your PR (ex. “Issue: 39. Issue title.”).
- If you are adding new feature provide documentation along with the PR. Also add it to upgrade notes
- If you are removing/renaming something or changing it's behavior also include it in upgrade notes
- Test your changes! Run your changes against any existing tests and create new ones when needed. Make sure your changes don’t break the existing project. Make sure that your branch is passing Travis CI build.
- If you have found a potential security vulnerability, please DO NOT report it on the public issue tracker. Instead, send it to us at email@example.com. We will work with you to verify and fix it as soon as possible. (https://github.com/DivanteLtd/vue-storefront/blob/master/README.md#documentation--table-of-contents))
If you are making any new feature make sure it's adjusted to our new, modular approach. Read more here
Use TS features only in new modules and Vuex (read TS Action Plan for more information)