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

chore: improve maintainers docs #1226

Merged

Conversation

WilliamBergamin
Copy link
Contributor

This PR aims to improve the maintainers documentation and PR template. It update the release instruction to match the python SDK and follow the Deno patterns

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

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others

Requirements (place an x in each [ ])

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • 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 ./scripts/install_all_and_run_tests.sh after making the changes.

@WilliamBergamin WilliamBergamin added docs Improvements or additions to documentation improvement labels Dec 18, 2024
@WilliamBergamin WilliamBergamin self-assigned this Dec 18, 2024
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.96%. Comparing base (5e41ae8) to head (7984dda).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1226   +/-   ##
=======================================
  Coverage   90.96%   90.96%           
=======================================
  Files         222      222           
  Lines        7501     7501           
=======================================
  Hits         6823     6823           
  Misses        678      678           

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

Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

LGTM! These formatting changes make future edits so much quicker - thanks for making this a PR 📚 ✨

I left a few comments and questions that might want to be reviewed before merging, but feel free to merge whenever! 🚢

.github/maintainers_guide.md Outdated Show resolved Hide resolved
- Create a new GitHub Release from the [Releases page](https://github.com/slackapi/bolt-python/releases) by clicking the "Draft a new release" button.
- Enter the new version number updated from the commit (e.g. `v1.2.3`) into the "Choose a tag" input.
- Ensure the tag `Target` branch is `main` (e.g `Target:main`).
- Click the "Create a new tag: x.x.x on publish" button. This won't create your tag immediately.
Copy link
Member

Choose a reason for hiding this comment

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

This won't create your tag immediately.

🙏 ✨

.github/maintainers_guide.md Show resolved Hide resolved
@WilliamBergamin WilliamBergamin merged commit f1fb115 into slackapi:main Dec 18, 2024
14 checks passed
@WilliamBergamin WilliamBergamin deleted the update-maintainers-guide branch December 18, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants