spacebarchat / spacebarchat/docs
Contribution guide
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 60
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
- How to create a new route
- How our schema/openapi stuff works
- How to send gateway events and what not to send (i.e. whole user obj vs PublicUser)
- How to set up a dev server and connect to it (hmmm cough cough?)
- How the server infra works? API and gateway communication for example. Maybe even future plans for gateway (guild nodes)
- How to write embed handlers? (for more sites)
- How to edit database models? Perhaps some gotchas with typeorm?
- How to add/use Config?
Contributor guide
No contributing guide indexed for this repository
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. Start by breaking the checklist into separate documentation tasks covering routes, OpenAPI/schema, gateway events, development setup, infrastructure, embed handlers, database models, and configuration. Done means the requested contribution guidance is documented and usable for each listed topic.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100