Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.52 KB

File metadata and controls

45 lines (35 loc) · 1.52 KB

Contributing Guide

Thanks for your interest in contributing! This document explains how to get set up and how we work together.

Quick Start

  1. Fork the repository and clone your fork.
  2. Install dependencies: npm install
  3. Create a branch: git checkout -b feat/your-change
  4. Run dev server: npm run dev
  5. Ensure formatting/linting passes: npm run lint
  6. Commit using Conventional Commits (see below) and open a Pull Request.

Branching Model

  • feat/* for features
  • fix/* for bug fixes
  • chore/* for chores and tooling
  • docs/* for documentation updates

Conventional Commits

Examples:

  • feat(hero): add animated subtitle
  • fix(projects): guard against missing image
  • docs(readme): update configuration section

Development Standards

  • TypeScript: prefer explicit types for exports and public APIs.
  • ESLint: keep npm run lint green.
  • 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.

Pull Request Checklist

  • 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)

Reporting Issues

Please include a minimal reproduction, expected/actual behavior, environment, and screenshots/logs when possible.

Code of Conduct

By participating, you agree to abide by our Code of Conduct.