Contributing Guide
Thanks for your interest in contributing! This document explains how to get set up and how we work together.
- Fork the repository and clone your fork.
- Install dependencies:
npm install - Create a branch:
git checkout -b feat/your-change - Run dev server:
npm run dev - Ensure formatting/linting passes:
npm run lint - Commit using Conventional Commits (see below) and open a Pull Request.
feat/*for featuresfix/*for bug fixeschore/*for chores and toolingdocs/*for documentation updates
Examples:
feat(hero): add animated subtitlefix(projects): guard against missing imagedocs(readme): update configuration section
- TypeScript: prefer explicit types for exports and public APIs.
- ESLint: keep
npm run lintgreen. - Components: prioritize clarity, accessibility, and small, focused components.
- Styling: use Tailwind utility classes; avoid unnecessary overrides.
- i18n: add/change strings in both EN and TR dictionaries.
- Title follows Conventional Commits
- Changes are scoped and focused
- Lint passes (
npm run lint) - Screenshots for UI changes (if applicable)
- Updated docs (README or comments)
Please include a minimal reproduction, expected/actual behavior, environment, and screenshots/logs when possible.
By participating, you agree to abide by our Code of Conduct.