A discord bot for teal.fm
besaid.zone
discord
tealfm
music
1# Contributing to Disco Stu
2
3Thanks for your interest in contributing! This document gives a short quickstart and guidelines to help you get changes ready for review.
4
5## Quickstart
6
71. Fork the repository and create a feature branch from `main`:
8
9```bash
10git checkout -b feat/describe-thing
11```
12
132. Install dependencies:
14
15```bash
16pnpm install
17```
18
193. Run the app you are working on (examples):
20
21```bash
22# Bot
23pnpm bot
24
25# Tapper
26pnpm tap
27
28# Web
29pnpm web
30
31# Build everything
32pnpm build
33```
34
354. Run typechecks and format/lint before pushing:
36
37```bash
38pnpm typecheck
39pnpm lint
40pnpm format
41```
42
43## Development workflow
44
45- Work on a small, focused branch per change.
46- Keep commits atomic and with clear messages (imperative tense): `add ping command`, `fix db migration`.
47- Rebase or squash as appropriate to keep history clean for PRs.
48
49## Tests, linting, and formatting
50
51- This repo uses `oxfmt` and `oxlint` at the workspace root. Run them locally before opening a PR.
52- Run TypeScript checks with `pnpm typecheck`.
53
54## Submitting a PR
55
56- Open a pull request against `main` with a clear description of the change and why it’s needed.
57- Include any relevant reproduction steps, screenshots, or logs.
58- If your change affects runtime behavior, add or update documentation in `README.md`.
59- Link any related issue numbers in the PR description.
60
61## Commit message guidance
62
63- Use short, descriptive commit messages.
64- Prefer present-tense verbs: `add`, `fix`, `update`.
65
66## Reporting bugs
67
68- Open an issue with steps to reproduce, expected vs actual behavior, and relevant logs or error messages.