Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.4 KB
Raw

Contributing

Thanks for your interest in contributing to Tikka! This guide explains the expected workflow for pull requests.

How to Contribute

Backend migration workflow

If your change touches the backend database schema, make sure the migration files are valid before submitting a PR. From the backend folder, run:

npm run migrations:check

This validates the migration numbering and filename format, and it helps prevent schema drift from reaching deployment. Create new migrations as database/migrations/NNN_name.sql with a zero-padded sequence and a snake_case name.

  1. Fork the repo and create a feature branch:
git checkout -b feat/your-change
  1. Make your changes with focused commits.
  2. Run checks before submitting:
pnpm lint
pnpm build
  1. Open a pull request with a clear description of the change.

Pull Request Checklist

  • Provide a concise summary of the change and motivation.
  • Keep the scope focused; avoid unrelated refactors.
  • Include screenshots or recordings for UI changes.
  • Add new UI strings to every locale under public/locales and run pnpm check:locales; missing or orphaned keys should be fixed before review.
  • Ensure pnpm lint and pnpm build pass.
  • Link related issues if applicable.

Reporting Issues

Use GitHub Issues to report bugs or propose improvements. Provide clear steps to reproduce and expected vs actual behavior.