Contribute to Quackback

Help us build something great. Whether you're fixing a bug, adding a feature, or improving docs, this guide shows you how to contribute effectively and get your changes merged.

Ways to Contribute

Bug reports - Found a bug? Open an issue
Feature requests - Have an idea? Start a discussion
Code contributions - Fix bugs or add features
Documentation - Improve guides and API docs
Translations - Help localize the platform

Get started

1. Fork the Repository

Click "Fork" on GitHub to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/quackback.git
cd quackback

3. Set Up Development Environment

bun run setup
bun run dev

See Development Setup for detailed instructions.

4. Create a Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-description

Make changes

Code Style

We use:

ESLint for code linting
Prettier for formatting
TypeScript for type safety

Run checks before committing:

bun run lint

For type checking (in apps/web):

cd apps/web && bun run typecheck

Naming Conventions

Type	Convention	Example
Files	kebab-case	`user-profile.tsx`
Components	PascalCase	`UserProfile`
Functions	camelCase	`getUserProfile`
Database	snake_case	`post_tags`

Component Guidelines

Use React Server Components by default
Add 'use client' only when needed (hooks, browser APIs)
Keep components focused and small
Extract complex logic to hooks or utilities

Database Changes

When modifying the schema:

Edit files in packages/db/src/schema/
Generate migration: bun run db:generate
Test migration: bun run db:migrate
Verify with Drizzle Studio: bun run db:studio

Testing

Run Tests

# Unit tests
bun run test
 
# E2E tests
bun run test:e2e
 
# Specific test file
bun run test path/to/test.ts

Write tests

Unit tests go in __tests__ directories next to the code they test:

packages/ids/src/
├── core.ts
└── __tests__/
    └── core.test.ts

E2E tests are in apps/web/e2e/.

Test Coverage

Aim for meaningful test coverage:

Critical business logic
Edge cases
Error handling

Submit changes

1. Commit Your Changes

Write clear commit messages:

# Good
git commit -m "fix: prevent duplicate votes on same post"
git commit -m "feat: add CSV export for posts"
 
# Bad
git commit -m "fixed stuff"
git commit -m "wip"

Follow conventional commits:

feat: - New feature
fix: - Bug fix
docs: - Documentation
refactor: - Code refactoring
test: - Adding tests
chore: - Maintenance

2. Push to Your Fork

git push origin feature/your-feature-name

3. Create a Pull Request

Go to the main Quackback repository
Click "Compare & pull request"
Fill in the PR template:
- Description of changes
- Related issues
- Screenshots (if UI changes)
- Testing done