matrix-org / matrix-org/matrix-hookshot

what is github oauth for?

Open
#156 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-Documentation
Dominant language
TypeScript
Stars
450
Forks
95
Avg merge
1d 2h
Merged PRs (30d)
23

Description

https://github.com/Half-Shot/matrix-hookshot/blob/c2504d86cc029cc707716e8a034b2c0853a14229/config.sample.yml#L24

You should clarify what part of the bridge oauth is needed for.
Is it needed to use the non-webhook features at all (such as those you showed in matrix live?)

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 config.sample.yml at line 24 and compare the GitHub OAuth setting with the non-webhook features shown in the linked Matrix Live video. Clarify in the configuration documentation what OAuth enables and whether it is required for those features; done means a newcomer can understand when the setting is needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.