Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.27 KB
Raw

Contributing

We welcome your contributions to the project. There are a few steps to take when looking to make a contribution.

  • Open an issue to discuss the feature/bug
  • If feature/bug is deemed valid then fork repo.
  • Implement patch to resolve issue.
  • Include tests to prevent regressions and validate the patch.
  • Update the docs for any API changes.
  • Submit a pull request.

Bug Reporting

Shopify API Library for Node uses GitHub issue tracking to manage bugs, please open an issue there.

Feature Request

You can open a new issue on the GitHub issues and describe the feature you would like to see.

Developing the library

Requirements:

You can set up your development environment by running the following:

git clone git@github.com:Shopify/shopify-api-node.git # get the code
cd shopify-node-api                                   # change into the source directory
yarn install                                          # install dependencies
yarn build                                            # build library

Helpful commands

  • yarn lint will run linting to make sure your code is of high standard
  • yarn test will run testing to ensure your code is covered by test cases