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.

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

#14 Write project readme file #15

Merged
merged 2 commits into from
Jun 6, 2024
Merged

#14 Write project readme file #15

merged 2 commits into from
Jun 6, 2024

Conversation

jkarenzi
Copy link
Collaborator

@jkarenzi jkarenzi commented Jun 5, 2024

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

  • Create an appealing README file
  • 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?

Copy link

vercel bot commented Jun 5, 2024

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

@jkarenzi jkarenzi linked an issue Jun 5, 2024 that may be closed by this pull request
3 tasks
@jkarenzi jkarenzi removed the WIP label Jun 6, 2024
Copy link
Collaborator

@ambroisegithub ambroisegithub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It Looks super for merging!!!

Copy link
Contributor

@wayneleon1 wayneleon1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good Job

Copy link
Contributor

@EddyShimwa EddyShimwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good Job!

- write detailed and comprehensive readme file

[Finishes #14]
- write detailed and comprehensive readme file

[Finishes #14]
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@dushimeemma dushimeemma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job @jkarenzi 🥇

@dushimeemma dushimeemma merged commit e6e16f6 into develop Jun 6, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write detailed README
7 participants