Contributing to Dalmatian
Thank you for your interest in contributing to Dalmatian! This guide will help you get started.
If this is your first time, follow SETUP.md first to create your Discord bot and run it locally.
How to Contribute
- Fork the repository or create a new branch if you have write access
- Create a new branch from
mainwith a descriptive name:git checkout -b your-feature-name # or git checkout -b bug-description - Make your changes following the code style and conventions
- Test your changes locally by running the bot
- Commit using conventional commits (see below)
- Push to your fork or branch
- Open a Pull Request with a clear description of your changes
Conventional Commits
This project follows Conventional Commits, which kennel’s git hooks check on every commit.
Examples:
feat: add course search by instructorfix: resolve dining hall location formatting issuedocs: update README installation stepsrefactor: simplify embed pagination logicchore: update dependencies to latest versionsstyle: format code with treefmt
Database Setup
The bot uses PostgreSQL for storing polls and reaction redirect configurations. You don’t need to install or start it yourself. pitchfork start --local runs a local PostgreSQL server, and the bot applies any pending migrations when it starts.
If you change the schema in src/db/, generate a new migration with:
deno task db:generate
To inspect the database, run deno task db:studio inside nix develop while PostgreSQL is running.
To completely reset the database, run pitchfork stop --local, delete .scottylabs/postgres, and start it again.
Before Submitting
Kennel’s git hooks run the linter, formatter, and tests on every commit. Before you open a pull request, also make sure to:
- Test your changes on your Discord bot by running
pitchfork start --local - Update documentation if you added/changed features
Pull Request Guidelines
- Keep PRs focused - One feature or fix per pull request
- Write clear descriptions - Explain what changed and why
- Reference related issues - Use “Fixes #123” or “Closes #456” if applicable
- Be responsive - Address review feedback promptly
Project Priorities & Planning
To understand current priorities, roadmap, and ongoing work, please check the issues board.
Need Help?
If you have questions or need help:
- Open an issue
- Check existing issues and pull requests for similar questions