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

Write detailed README #14

Closed
3 tasks
jkarenzi opened this issue Jun 5, 2024 · 0 comments · Fixed by #15
Closed
3 tasks

Write detailed README #14

jkarenzi opened this issue Jun 5, 2024 · 0 comments · Fixed by #15
Assignees
@jkarenzi
Labels
Front-End WIP

Comments

@jkarenzi
Copy link
Collaborator

jkarenzi commented Jun 5, 2024 •
edited
Loading

Description

As a developer, I want to create a comprehensive README file for the e-commerce project, providing crucial information about the project, its setup, and its status. Additionally, I want to add relevant badges to the README to display important project metrics and build statuses at a glance.

A well-written README file and informative badges will help new contributors and stakeholders understand the project quickly and make it easier to collaborate and contribute effectively.

Tasks

  • Create an appealing README file
  • Include project description, installation instructions, and usage examples
  • Add badges for build status, test coverage, and code quality

Related issues

Definition of Done

  • README file is appealing
  • README file includes project description, installation instructions, and usage examples
  • README file contains badges for build status, test coverage, and code quality
@jkarenzi jkarenzi self-assigned this Jun 5, 2024
jkarenzi added a commit that referenced this issue Jun 5, 2024
@jkarenzi
chore(write-readme): write project readme file
89e66ff 
- write detailed and comprehensive readme file

[Finishes #14]
@jkarenzi jkarenzi mentioned this issue Jun 5, 2024
Merged
3 tasks
@jkarenzi jkarenzi linked a pull request Jun 5, 2024 that will close this issue
#14 Write project readme file #15
Merged
3 tasks
@jkarenzi jkarenzi added the WIP label Jun 5, 2024
jkarenzi added a commit that referenced this issue Jun 6, 2024
@jkarenzi
chore(write-readme): write project readme file
3ca215d 
- write detailed and comprehensive readme file

[Finishes #14]
jkarenzi added a commit that referenced this issue Jun 6, 2024
@jkarenzi
chore(write-readme): write project readme file
8015968 
- write detailed and comprehensive readme file

[Finishes #14]
dushimeemma pushed a commit that referenced this issue Jun 6, 2024
@jkarenzi
#14 Write project readme file (#15)
e6e16f6 
* chore(write-readme): write project readme file

- write detailed and comprehensive readme file

[Finishes #14]

* chore(write-readme): write project readme file

- write detailed and comprehensive readme file

[Finishes #14]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jkarenzi jkarenzi

Labels
Front-End WIP
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#14 Write project readme file atlp-rwanda/dynamites-ecomm-fe
1 participant
@jkarenzi