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

feat: add download badge in readme #1449

Merged
merged 4 commits into from
Jan 12, 2024

Conversation

WilliamBergamin
Copy link
Contributor

Summary

The goal of this PR is to add the a downloads badge to the readme, the title and badges were also centered.

Testing

look at this fork to see the rendered version

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs-src (Documents, have you run ./scripts/docs.sh?)
  • /docs-src-v2 (Documents, have you run ./scripts/docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)
  • README.md

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@WilliamBergamin WilliamBergamin added the docs M-T: Documentation work only label Jan 9, 2024
@WilliamBergamin WilliamBergamin self-assigned this Jan 9, 2024
Copy link

codecov bot commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (03bd99e) 85.65% compared to head (df17867) 85.66%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1449   +/-   ##
=======================================
  Coverage   85.65%   85.66%           
=======================================
  Files         111      111           
  Lines       12137    12137           
=======================================
+ Hits        10396    10397    +1     
+ Misses       1741     1740    -1     

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

@srajiang
Copy link
Member

srajiang commented Jan 9, 2024

I noticed the contact/support badge is not visible in the badges rendered on your fork. Assuming that's intentional?

@seratch
Copy link
Member

seratch commented Jan 9, 2024

I believe it should be intentional. If so, I am fine with it too as the README mentions the GH issue tracker and community links at the bottom.

@seratch seratch added this to the 3.26.3 milestone Jan 9, 2024
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

When the convo about the support link is resolved, you can merge this PR!

@WilliamBergamin
Copy link
Contributor Author

@srajiang I don't think the contact/support badge was still relevant, I tested it out and the link redirected me to one of my workspaces /help/requests which seems to be targeted for general slack users not developer specific

@WilliamBergamin WilliamBergamin merged commit f671c45 into slackapi:main Jan 12, 2024
12 checks passed
@WilliamBergamin WilliamBergamin deleted the improve-readme branch January 12, 2024 16:05
@seratch seratch modified the milestones: 3.26.3, 3.27.0 Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants