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

docs: add "badges" to README #36

Open
castarco opened this issue Sep 7, 2023 · 4 comments
Open

docs: add "badges" to README #36

castarco opened this issue Sep 7, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest For tasks eligible for Hacktoberfest participation

Comments

@castarco
Copy link
Contributor

castarco commented Sep 7, 2023

Add some "nice" badges to the README, so people can have a better idea about "quality metrics" at first sight.

@castarco castarco added the documentation Improvements or additions to documentation label Sep 7, 2023
@castarco castarco added good first issue Good for newcomers hacktoberfest For tasks eligible for Hacktoberfest participation labels Sep 15, 2023
@Tejoooo
Copy link

Tejoooo commented Sep 30, 2023

Heyy @castarco I m interested in this work can u assign me this issue

@castarco
Copy link
Contributor Author

Hi @Tejoooo . Yes, it's all yours.

One detail, though: Please, do not add badges that contain hardcoded values (except for the license). I already closed a PR from another person that did that and doubled down on that approach after I commented that it was not a good idea.

@Tejoooo
Copy link

Tejoooo commented Sep 30, 2023

So @castarco wht am I supposed to do exactly , can you give me more details of your context.

@castarco
Copy link
Contributor Author

castarco commented Sep 30, 2023

@Tejoooo you can take inspiration from other projects I'm maintaining.

For example https://raw.githubusercontent.com/Coder-Spirit/nominal/main/README.md

Note, though, that the example I gave you is a simple repository, while this one is a monorepo, so we need badges for README files of the 3 subprojects, and badges for the "global" README (the global README does not need badges related to any specific package, of course, just the ones that are generic enough for the repository).

EDIT: I'm taking care of the Snyk integrations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest For tasks eligible for Hacktoberfest participation
Projects
None yet
Development

No branches or pull requests

2 participants