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 (make sure you first have yarn installed):
yarn
To see documentation about npm scripts used in this project run:
yarn info
While developing the following command will run tests in browser at http://localhost:4200. It also watches the src/ and tests/ directory and rebuilds as needed:
yarn start
If you'd simply like to manually run tests do:
yarn test
The following documents the folder structure for this project and what the purpose of each folder is:
+-- docs/ ** API docs that live at http://shopify.github.io/js-buy-sdk
+-- scripts/ ** Scripts used for development such as build and CI scripts
| +-- ci/ ** Scripts used to setup/run CI
+-- src/ ** Contains all JS used by the JS buy SDK
| +-- adapters/
| +-- metal/
| +-- models/
| +-- serializers/
+-- tests/ ** Contains tests used to ensure the js-buy-sdk works as intended
+-- fixtures/
+-- helpers/
+-- integration/
+-- shims/
+-- unit/
+-- adapters/
+-- api/
+-- lint/
+-- metal/
+-- models/
+-- serializers/
See here for our examples.
Please do not update documentation, as this may cause merge conflicts. After a pull request has been merged, the maintainers will update documentation and release a new version.
The docs live inside the docs/ folder and are hosted
at http://shopify.github.io/js-buy-sdk.
To generate docs run the following:
yarn doc:build
To preview the built docs run:
yarn doc:serve
The documentation will then be visible at:
http://127.0.0.1:4201