#14 Write project readme file

atlp-rwanda / dynamites-ecomm-fe

https://dynamites-ecomm-fe.netlify.app/

0 stars 0 forks source link

#14 Write project readme file #15

Closed jkarenzi closed 3 weeks ago

jkarenzi commented 3 weeks ago

What does this PR do?

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

Description of the tasks to be completed

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

How can this be manually tested?

By previewing the readme file in vscode or taking a look at it in the root directory of the dynamites-ecomm-fe repo.

What are the relevant pivotal trackers/story id?

vercel[bot] commented 3 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dynamites-ecomm-fe	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 6, 2024 4:34pm

codecov-commenter commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 17.24%. Comparing base (caf0955) to head (8015968).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #15 +/- ## ======================================== Coverage 17.24% 17.24% ======================================== Files 4 4 Lines 29 29 Branches 4 4 ======================================== Hits 5 5 Misses 21 21 Partials 3 3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.