matrix-org / matrix-org/matrix-bifrost
Document backend API
Open
Nobody has claimed this yet.
T-Documentation
- Dominant language
- TypeScript
- Stars
- 187
- Forks
- 38
- PR merge metrics
- No merged PRs in 30d
Description
This means things like the interfaces used for backends, when things are generally called and what events should be fired when.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Begin by locating the backend interfaces and event definitions, then map when each interface is called and which events are expected. Done means the backend API's interfaces, call timing, and event behavior are documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100