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

[JOSS] Add badges to README #34

Closed
sappelhoff opened this issue Oct 12, 2022 · 1 comment
Closed

[JOSS] Add badges to README #34

sappelhoff opened this issue Oct 12, 2022 · 1 comment

Comments

@sappelhoff
Copy link
Contributor

sappelhoff commented Oct 12, 2022

It'd be very convenient to get the following "badges" from your README:

  • travis status, given that this CI is still running as expected. If it doesn't now would be a good time to remove or fix it
  • PyPI status
  • Conda status (I can't find your "edeno" channel and the package right now)
  • readthedocs

Furthermore, it'd be nice to have a badge for test coverage, for example using https://about.codecov.io/
See this repo for an example: https://github.com/bids-standard/pybv/blob/4af6bbab86e6151a3a64d759d4eca4a15e9b253a/.github/workflows/python_tests.yml#L81-L85

xref: openjournals/joss-reviews#4840

edeno added a commit that referenced this issue Oct 14, 2022
edeno added a commit that referenced this issue Oct 14, 2022
Addresses issue #34
@edeno
Copy link
Contributor

edeno commented Oct 14, 2022

@sappelhoff I added the requested badges to the README.

@edeno edeno closed this as completed Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants