Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Latest commit

 

History

History
53 lines (38 loc) · 1.72 KB

Contributing.md

File metadata and controls

53 lines (38 loc) · 1.72 KB

Contributing

To contribute to create-commerce-app, follow the guidelines below. This helps us address your pull request in a more timely manner.

Setup

Execute the following commands to install dependencies and build create-commerce-app locally.

npm install

Testing

To run tests, execute

npm run test

To print the detailed test results and errors on the console, execute

npm run test:debug

Submitting a Pull Request

  1. Create a new issue. It allows us to easily communicate with you about the issue.
  2. Create a fork of this repository.
  3. Create a branch off the master branch.
  4. Add your changes to the fork.
  5. Create a pull request against the master branch.
  6. Grant dx-runtime team access to your fork so we can run automated tests on your pull request prior to merging it.

Best Practices

  • To reduce merge conflicts, squash and rebase your branch before submitting your pull request.
  • If applicable, reference the issue number in the comments of your pull request.
  • In your pull request, include:
    • A brief description of the problem and your solution
    • Steps to reproduce
    • Screen shots
    • Error logs
  • Make sure that your code builds and passes the unit tests.
  • Monitor your pull requests. Please respond in a timely manner to any comments, questions for changes requested. We may close abandoned pull requests.

What to expect

After you submit your pull request, we'll look it over and consider it for merging.

As long as your submission has met the above guidelines, we should merge it in a timely manner.

Contributor License Agreement (CLA)

All external contributors must sign our Contributor License Agreement (CLA).