slackapi / slackapi/bolt-js

Add docs/sample for using browser cookies to pass custom app data during OAuth flow

Open
#2,124 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area:examples auto-triage-skip docs enhancement good first issue semver:patch
Dominant language
TypeScript
Stars
2.9k
Forks
445
Avg merge
1d 3h
Merged PRs (30d)
28

Description

We have many inquiries from users on how to pass custom data through the Slack OAuth flow (for example, to associate a Slack user with the app's user):

Typically, us maintainers answer these questions by linking to previous other issues/questions where this is explained to users.

Instead, we should write a document on how to do it, and add a sample application showing the technique. In general, the OAuth documentation could use a review and rewrite. Perhaps it is worth pulling in our Education team to help with this effort!

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 by reviewing the existing OAuth documentation and the related discussions in issues 2123 and 1453 to identify the cookie-based data flow that should be documented. Done should include a clear document and a sample application demonstrating the technique, with the broader OAuth documentation review scoped explicitly.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
authentication, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.