This document describes tools, tasks and workflow that one needs to be familiar with in order to effectively maintain this project. If you use this package within your own software as is but don't plan on modifying it, this guide is not for you.

We recommend using pyenv for Python runtime management. If you use macOS, follow the following steps:

$ brew update
$ brew install pyenv

Install necessary Python runtimes for development/testing. You can rely on GitHub Actions workflows for testing with various major versions. https://github.com/slackapi/bolt-python/tree/main/.github/workflows

$ pyenv install -l | grep -v "-e[conda|stackless|pypy]"

$ pyenv install 3.8.5 # select the latest patch version
$ pyenv local 3.8.5

$ pyenv versions
  system
  3.7.17
  3.13.7
* 3.8.5 (set by /path-to-bolt-python/.python-version)

$ pyenv rehash

Then, you can create a new Virtual Environment this way:

$ python -m venv env_3.8.5
$ source env_3.8.5/bin/activate

If you make some changes to this SDK, please write corresponding unit tests as much as possible. You can easily run all the tests by running the following script.

If this is your first time to run tests, although it may take a bit long time, running the following script is the easiest.

$ ./scripts/install_all_and_run_tests.sh

Once you installed all the required dependencies, you can use the following one.

$ ./scripts/run_tests.sh

Also, you can run a single test this way.

$ ./scripts/run_tests.sh tests/scenario_tests/test_app.py

If you make changes to slack_bolt/adapter/*, please verify if it surely works by running the apps under examples directory.

# Install all optional dependencies
$ pip install -r requirements/adapter.txt
$ pip install -r requirements/adapter_testing.txt

# Set required env variables
$ export SLACK_SIGNING_SECRET=***
$ export SLACK_BOT_TOKEN=xoxb-***

# Standalone apps
$ cd examples/
$ python app.py
$ python async_app.py

# Flask apps
$ cd examples/flask
$ FLASK_APP=app.py FLASK_ENV=development flask run -p 3000

# In another terminal
$ ngrok http 3000 --subdomain {your-domain}

If you want to test the package locally you can.

1. Build the package locally
   • Run

     scripts/build_pypi_package.sh

   • This will create a .whl file in the ./dist folder
2. Use the built package
   • Example /dist/slack_bolt-1.2.3-py2.py3-none-any.whl was created
   • From anywhere on your machine you can install this package to a project with

     pip install <project path>/dist/slack_bolt-1.2.3-py2.py3-none-any.whl

   • It is also possible to include slack_bolt @ file:///<project path>/dist/slack_bolt-1.2.3-py2.py3-none-any.whl in a requirements.txt file

./scripts/generate_api_docs.sh

[testpypi]
username: {your username}
password: {your password}

1. Create a branch in which the development release will live:

   • Bump the version number in adherence to Semantic Versioning and Developmental Release in slack_bolt/version.py
     • Example the current version is 1.2.3 a proper development bump would be 1.3.0.dev0
     • .dev will indicate to pip that this is a Development Release
     • Note that the dev version can be bumped in development releases: 1.3.0.dev0 -> 1.3.0.dev1
   • Commit with a message including the new version number. For example 1.3.0.dev0 & Push the commit to a branch where the development release will live (create it if it does not exist)
     • git checkout -b future-release
     • git commit -m 'version 1.3.0.dev0'
     • git push future-release
   • Create a git tag for the release. For example git tag v1.3.0.dev0.
   • Push the tag up to github with git push origin --tags

2. Distribute the release

   • Use the latest stable Python runtime
   • python -m venv .venv
   • ./scripts/deploy_to_pypi_org.sh
   • You do not need to create a GitHub release

3. (Slack Internal) Communicate the release internally

1. Create the commit for the release:

   • Bump the version number in adherence to Semantic Versioning in slack_bolt/version.py
   • Build the docs with ./scripts/generate_api_docs.sh.
   • Commit with a message including the new version number. For example 1.2.3 & Push the commit to a branch and create a PR to sanity check.
     • git checkout -b v1.2.3
     • git commit -a -m 'version 1.2.3'
     • git push -u origin HEAD
   • Open a PR and merge after receiving at least one approval from other maintainers.

2. Distribute the release

   • Use the latest stable Python runtime
     • git checkout main && git pull
     • python --version
     • python -m venv .venv
     • ./scripts/deploy_to_pypi_org.sh
   • Create a new GitHub Release from the Releases page 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.
     • Name the release after the version number updated from the commit (e.g. version 1.2.3)
     • Auto-generate the release notes by clicking the "Auto-generate release notes" button. This will pull in changes that will be included in your release.
     • Edit the resulting notes to ensure they have decent messaging that are understandable by non-contributors, but each commit should still have it's own line.
     • Ensure that this version adheres to semantic versioning. See Versioning for correct version format. Version tags should match the following pattern: v2.5.0.

   ## New Features
   
   ### Awesome Feature 1
   
   Description here.
   
   ### Awesome Feature 2
   
   Description here.
   
   ## Changes
   
   * #123 Make it better - thanks @SlackHQ
   * #123 Fix something wrong - thanks @seratch

3. (Slack Internal) Communicate the release internally

   • Include a link to the GitHub release

4. Make announcements

   • #tools-bolt in community.slack.com

5. (Slack Internal) Tweet by @SlackAPI

   • Not necessary for patch updates, might be needed for minor updates, definitely needed for major updates. Include a link to the GitHub release

This project uses semantic versioning, expressed through the numbering scheme of PEP-0440.

main is where active development occurs. Long running named feature branches are occasionally created for collaboration on a feature that has a large scope (because everyone cannot push commits to another person's open Pull Request). At some point in the future after a major version increment, there may be maintenance branches for older major versions.

Labels are used to run issues through an organized workflow. Here are the basic definitions:

• bug: A confirmed bug report. A bug is considered confirmed when reproduction steps have been documented and the issue has been reproduced.
• enhancement: A feature request for something this package might not already do.
• docs: An issue that is purely about documentation work.
• tests: An issue that is purely about testing work.
• discussion: An issue that is purely meant to hold a discussion. Typically the maintainers are looking for feedback in this issues.
• question: An issue that is like a support request because the user's usage was not correct.

Triage is the process of taking new issues that aren't yet "seen" and marking them with a basic level of information with labels. An issue should have one of the following labels applied: bug, enhancement, question, needs feedback, docs, tests, or discussion.

Issues are closed when a resolution has been reached. If for any reason a closed issue seems relevant once again, reopening is great and better than creating a duplicate issue.

See the /docs/README.md file for documentation instructions.

When in doubt, find the other maintainers and ask.