Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 3.64 KB
Raw

How to Contribute

Already a JavaScript/Vue.js developer? Pick an issue, push a pull request (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!

You can start a ready-to-code development environment in your browser, by clicking the button below:

Open in Gitpod

Thank you for your interest in, and engagement!

Before you type an issue please read about out release lifecycle.

Branches

You should fork the project or create a 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.
  • RC-x (x is current version) - release candidate branch with features that will land in next version.

Please use "develop" or "RC" 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 the 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 contributors@vuestorefront.io.

Tag your issues properly. If you found a bug, tag it with bug label. If you're requesting new feature, tag it with feature request label.

Git Flow

We're introducing TypeScript to Vue Storefront core, so you can use it where it's appropriate - but please be pragmatic. Here are some thoughts on how to use TypeScript features in Vue Storefront: TypeScript Action Plan.

Pull Request Checklist

ALWAYS use Pull Request template it's automatically added to each PR.

  1. Fork the repository and clone it locally from the 'develop' branch. Make sure it's up to date with current develop branch
  2. Create a branch for your edits. Use the following branch naming conventions:
  • bugfix/task-title
  • feature/task-name
  1. Use Pull Request template and fill as much fields as possible to describe your solution.
  2. Reference any relevant issues or supporting documentation in your PR (ex. “Issue: 39. Issue title.”).
  3. If you are adding new feature provide documentation along with the PR. Also, add it to upgrade notes
  4. If you are removing/renaming something or changing its behavior also include it in upgrade notes
  5. 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.
  6. If you have found a potential security vulnerability, please DO NOT report it on the public issue tracker. Instead, send it to us at contributors@vuestorefront.io. 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))

Acceptance Criteria

Your pull request will be merged after meeting following criteria:

  • Everything from "Pull Request Checklist"
  • PR is proposed to appropriate branch
  • There are at least two approvals from core team members