@busieinc/types
v1.0.1
Published
Common Typescript Types across the Busie Platform
Downloads
63
Readme
Busie Types NPM Package
Installation
npm run --save-dev @busieinc/types
Contributing
Note:
Contrary to the steps outlined below, testing is not really possible at this time, due to the steps needed to actually publish the package. These steps are the desired contribution steps, however, since testing is not possible, it will be necessary to manually test when contributing temporarily
- Clone the Repository
- Change directory into project root
- Check out a new branch
types/the-type-you-will-add
- Run Tests first (or lint, it's the same thing)
npm run test
ornpm run lint
- Add your types and interfaces to index.d.ts
- Add tests to busie-tests.ts (basically just examples of how the types should work/be used)
- Run Tests again
npm run test
ornpm run lint
- Assuming everything works, create a pull request!