Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.08 KB

Contributing.md

File metadata and controls

21 lines (15 loc) · 1.08 KB
Raw

Contributing

Thank you for your interest in contributing to wstrade-api! 🥳🥳

To get ramped up, please make sure to go through this checklist:

  • Read through the documentation
  • Read through the code
  • Understand the state of the project by taking a look at issues

Checklist before opening a PR

Once your changes are ready for review, please make sure you run through this checklist beforehand:

  • Have you verified your changes with existing testcases by running npm test?
  • Did you update the output dist.js by running npm run bundle?
  • Does the lint test passes? verify by running npm run lint
  • Did you update the npm version in package.json/package-lock.json to reflect the semver protocol adopted by wstrade-api?
  • Have you updated the index.d.ts file to reflect any API changes you made?
  • Have you updated the CHANGELOG.md file with the new version you are introducing?
  • Once you have pushed the commit in Main create a new release for the new tag and delete the release