slackapi / slackapi/bolt-js

docs: convert remaining code examples from CommonJS to ESM

Open Beginner friendly
#2,923 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

auto-triage-skip docs enhancement
Dominant language
TypeScript
Stars
2.9k
Forks
445
Avg merge
1d 3h
Merged PRs (30d)
28

Description

Summary

The quickstart guides and README were updated to use ESM imports in #2923. The remaining docs still use require() syntax and should be converted to import for consistency.

Files to update

English:

  • docs/english/concepts/authenticating-oauth.md
  • docs/english/concepts/custom-routes.md
  • docs/english/concepts/deferring-initialization.md
  • docs/english/concepts/error-handling.md
  • docs/english/concepts/logging.md
  • docs/english/concepts/message-listening.md
  • docs/english/concepts/receiver.md
  • docs/english/concepts/socket-mode.md
  • docs/english/concepts/token-rotation.md
  • docs/english/deployments/aws-lambda.md
  • docs/english/tutorials/code-assistant.md

Japanese:

  • docs/japanese/concepts/authenticating-oauth.md
  • docs/japanese/concepts/custom-routes.md
  • docs/japanese/concepts/deferring-initialization.md
  • docs/japanese/concepts/error-handling.md
  • docs/japanese/concepts/logging.md
  • docs/japanese/concepts/message-listening.md
  • docs/japanese/concepts/socket-mode.md
  • docs/japanese/deployments/aws-lambda.md

Out of scope

  • docs/english/legacy/steps-from-apps.md and docs/japanese/legacy/steps-from-apps.md — deprecated, no update needed.

Notes

  • Most files are a straightforward requireimport swap.
  • Lambda deployment docs also use module.exports which should become export const handler.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the English and Japanese Markdown files listed under concepts, deployments, and tutorials, and search them for require() and module.exports; use the ESM examples already applied in the quickstart guides and README as the reference. Convert the in-scope examples, including the Lambda handlers, while leaving both legacy/steps-from-apps.md files unchanged. Done means all listed docs use ESM consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.