linkedin/coral

Improve Documentation and Project Visibility: Add Status Badges to README

1fanwang opened this issue · 0 comments

Problem

Our project README currently lacks visual indicators of the project's status, making it difficult for potential users and contributors to quickly assess the health and activity of the project. Specifically:

  1. There's no immediate way to see if the build is passing or failing.
  2. The latest release version isn't readily visible.
  3. There's no indication of our test coverage enforcement status.

These missing elements can impact the project in several ways:

  • New users might be unsure if the project is actively maintained.
  • Contributors can't quickly determine if their changes have broken the build.
  • The overall health and quality of the project isn't immediately apparent.

Improvement

To address these issues, we should consider adding status badges to our README. Some areas we might want to cover include:

  1. Build status
  2. Latest release version
  3. Test coverage
  4. Any other relevant project metrics