Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (55 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

78 lines (55 loc) · 2.03 KB
Raw

Contributing to DevCard

Thank you for your interest in contributing to DevCard! This guide will help you get started.

Development Setup

Prerequisites

  • Node.js >= 20
  • pnpm >= 9
  • Docker & Docker Compose
  • React Native dev environment — follow the official setup guide

Getting Started

# 1. Fork and clone the repo
git clone https://github.com/Dev-Card/DevCard.git
cd devcard

# 2. Install dependencies
pnpm install

# 3. Start PostgreSQL + Redis
docker compose up -d

# 4. Configure environment
cp .env.example .env
# Edit .env with your OAuth credentials

# 5. Run database migrations and seed
pnpm db:migrate
pnpm db:seed

# 6. Start development
pnpm dev:backend    # Backend API on :3000
pnpm dev:mobile     # React Native app

Project Structure

devcard/
├── apps/backend/     # Fastify API (TypeScript)
├── apps/mobile/      # React Native mobile app
├── apps/web/         # SvelteKit web backup
└── packages/shared/  # Shared types, utils, platform registry

Coding Standards

  • TypeScript for all new code
  • ESLint + Prettier for formatting (run pnpm lint before committing)
  • Conventional Commits for commit messages (feat:, fix:, docs:, chore:)
  • Write tests for new features and bug fixes

Pull Request Process

  1. Create a feature branch from main: git checkout -b feat/your-feature
  2. Make your changes with clear, descriptive commits
  3. Ensure all tests pass: pnpm test
  4. Ensure linting passes: pnpm lint
  5. Open a PR against main with a clear description of the change
  6. Wait for review — maintainers will respond within 48 hours

Reporting Issues

  • Use GitHub Issues for bug reports and feature requests
  • Include reproduction steps for bugs
  • Search existing issues before creating a new one

Code of Conduct

Be kind, inclusive, and constructive. We follow the Contributor Covenant.

Thank you for helping make DevCard better! 🎉