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: Added badges to README.md #528

Conversation

max-pfeiffer
Copy link
Contributor

I added the following badges:

  • Poetry
  • Ruff
  • Supported Python versions
  • Workflow runs

@max-pfeiffer max-pfeiffer changed the title Added badges to README.md feat: Added badges to README.md Apr 5, 2024
@alexanderankin
Copy link
Member

here are the ones on readthedocs (which still needs to be fixed on the build side (either transferring the testcontainers-python subdomain, or the testcontainers subdomain set up via someone's auth who has permissions to create webhooks on this repo):

testcontainers-python
=====================
.. image:: https://github.com/testcontainers/testcontainers-python/actions/workflows/ci-core.yml/badge.svg
:target: https://github.com/testcontainers/testcontainers-python/actions/workflows/ci-core.yml
.. image:: https://img.shields.io/pypi/v/testcontainers.svg
:target: https://pypi.python.org/pypi/testcontainers
.. image:: https://readthedocs.org/projects/testcontainers-python/badge/?version=latest
:target: http://testcontainers-python.readthedocs.io/en/latest/?badge=latest
.. image:: https://github.com/codespaces/badge.svg
:target: https://codespaces.new/testcontainers/testcontainers-python

@alexanderankin
Copy link
Member

maybe it makes sense for the badges to match, maybe not, idk

@alexanderankin alexanderankin changed the title feat: Added badges to README.md docs: Added badges to README.md Apr 5, 2024
@max-pfeiffer
Copy link
Contributor Author

@alexanderankin Thanks for pointing that out. I just added the missing badges for docs and codespace. I choose to add the code space badge below the others is this one is breaking the layout a bit. That way it doesn't look too awkward.

@totallyzen The badges do match now. I just added some additional badges.

@alexanderankin
Copy link
Member

im going to merge to test the webhook

@alexanderankin alexanderankin merged commit 0bbb871 into testcontainers:docs/improve-contribution-guide Apr 5, 2024
1 check passed
@alexanderankin
Copy link
Member

sorry, i thought this was merging into main, my apologies.

alexanderankin pushed a commit that referenced this pull request Jun 27, 2024
I added the following badges:
- Poetry
- Ruff
- Supported Python versions
- Workflow runs
alexanderankin pushed a commit that referenced this pull request Jun 28, 2024
I added the following badges:
- Poetry
- Ruff
- Supported Python versions
- Workflow runs
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

Successfully merging this pull request may close these issues.

2 participants