Thank you for your interest in contributing! Here's how you can help.
This project follows the Contributor Covenant. By participating, you agree to uphold it.
- Check if the bug has already been reported in Issues
- If not, open a new issue with:
- A clear title and description
- Steps to reproduce
- Expected vs actual behavior
- Screenshots (if applicable)
- Environment details (OS, browser, version)
Open an issue with the label enhancement describing:
- The problem you're trying to solve
- Your proposed solution
- Any alternatives you've considered
- Fork the repository
- Create a branch:
git checkout -b feature/my-feature - Make your changes
- Run the linter:
cd client && npx tsc --noEmit - Commit with a descriptive message
- Push and open a Pull Request
- Keep PRs focused on a single concern
- Update documentation if needed
- Add tests when possible
- Follow existing code style (TypeScript strict mode)
- Ensure the build passes:
cd client && npm run build
See README.md for setup instructions.
client/— React frontend (Vite + TypeScript)server/— Express backend (TypeScript)server/src/migrations/— SQL migrations (run automatically on server start)
We use conventional commits:
feat:— New featurefix:— Bug fixrefactor:— Code change without feature/fixdocs:— Documentationchore:— Maintenancesecurity:— Security fix