Skip to content

Latest commit

 

History

History
12 lines (11 loc) · 726 Bytes

CONTRIBUTING.md

File metadata and controls

12 lines (11 loc) · 726 Bytes

Steps to Add a public Api to a Service

  1. Add the required Api in the particular service interface. (LocationService.ts)
  2. Add the specific implementation for the respective Api. (LocationServiceImpl.ts)
  3. Add contract test for request and response models. (response.models.int.test.ts)
  4. Add integration test. (Location.int.test.ts)
  5. Add public facing models like Location in respective index.ts. (location/index.ts)
  6. Add unit test for post/websocket respectively . (LocationPostService.unit.test.ts/LocationWsService.unit.test.ts)
  7. Add example in the documentation (LocationExample.ts)
  8. Add api doc around the added Api.
  9. Add typedoc category to the added models (if possible).
  10. Add CHANGELOG entry (imp).