Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ReadMe #96

Open
Anoushka21 opened this issue Apr 27, 2024 · 0 comments
Open

Update ReadMe #96

Anoushka21 opened this issue Apr 27, 2024 · 0 comments
Assignees
@EyuEyu
Labels
enhancement New feature or request

Comments

@Anoushka21
Copy link
Collaborator

Anoushka21 commented Apr 27, 2024 •
edited
Loading

As a developer
I need an updated Readme
So that everyone can understand the codebase

Details and Assumptions

  • add the microservice route
  • Add information about the promotions service
    * Details about promotion service and what kind of promotions are supported
    * Information and details about API endpoints
    * How to run the service locally - mention commands for testing, linting etc make test , make lint, honcho start and behave
  • Add link to swagger apidocs

Acceptance Criteria

Given the github repository
When I access the ReadMe
Then I am able to understand and use the codebase effeciently
@Anoushka21 Anoushka21 added the enhancement New feature or request label Apr 27, 2024
@EyuEyu EyuEyu self-assigned this May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@EyuEyu EyuEyu

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@EyuEyu @Anoushka21