project icon indicating copy to clipboard operation
project copied to clipboard

Update Technical Documentation For vNext

Open ei-nghon-phoo opened this issue 11 months ago • 3 comments

As a Mojaloop adopter,

I want to update the vnext repositories with the standard readme document

so that fundamental information such as what the service does, how to run the service, tests, C/CD steps and related details can be easily found.

The readme page to include the following sections at the least:

  • [ ] Basic description of the BC / repository
  • [ ] Testing, coverage details, how to run
  • [ ] CI/CD (Continuous Integration/Continuous Deployment) process for the BC
  • [ ] Known issues if any
  • [ ] Environment variables to be set / configured

ei-nghon-phoo avatar Mar 12 '24 02:03 ei-nghon-phoo

Hello @bushjames and @TW-Ei-Nghon-Phoo can I understand why this has been put at the top of the backlog?

JulieG19 avatar Apr 17 '24 04:04 JulieG19

Thanks @JulieG19 for pointing this out.

This came to the top out of one of the prioritization meetings right after the workstream started officially. This in turn came from the beta review report, where repositories needed basic information on the bounded-contexts / services on what the service does, how to run it and such information (items listed).

elnyry-sam-k avatar Apr 18 '24 19:04 elnyry-sam-k

This ticket should be done already - meeting to be organised between @elnyry-sam-k and @hsuyeemon-tw

JulieG19 avatar Apr 22 '24 10:04 JulieG19