We ❤️ pull requests. If you'd like to fix a bug, contribute 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, first fork the repo, then clone it:
git clone git@github.com:your-username/js-buy-sdk.git
Note: replace "your-username" with your Github handle
Install the project's dependencies:
npm install
Run the server:
npm start
Add some tests and make your change. Re-run the tests with:
npm run test
See here for our examples.
If your change affects how people use the project (i.e. adding or
changing arguments to a function, adding a new function, changing the
return value, etc), please ensure the documentation is also updated to
reflect this. The docs live inside the gh-pages branch and are hosted
at shopify.github.io/js-buy-sdk.
git checkout -b my-feature-branch gh-pages
script/yuidoc
jekyll serve
The documentation will then be visible at
http://localhost:4000/js-buy-sdk/index.html