Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (87 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

116 lines (87 loc) · 2.69 KB

Contributing to Syncally Community

Thank you for your interest in contributing to Syncally Community! This document provides guidelines and instructions for contributing.

Code of Conduct

Please be respectful and constructive in all interactions. We're building something together.

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue with:
    • Clear title and description
    • Steps to reproduce
    • Expected vs actual behavior
    • Your environment (OS, Node version, etc.)

Suggesting Features

  1. Check existing Issues for similar suggestions
  2. Create a new issue with the "enhancement" label
  3. Describe the feature and its use case

Pull Requests

  1. Fork the repository

  2. Create a feature branch

    git checkout -b feature/your-feature-name

  3. Make your changes

    • Follow the existing code style
    • Add tests if applicable
    • Update documentation as needed

  4. Test your changes

    pnpm typecheck
pnpm lint
pnpm build

  5. Commit with clear messages

    git commit -m "feat: add awesome feature"

    We follow Conventional Commits:

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

  6. Push and create a Pull Request

    git push origin feature/your-feature-name

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/platform.git
cd platform

# Install dependencies
pnpm install

# Set up environment
cp .env.example .env

# Start database
docker run -d --name syncally-db \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=syncally_community \
  -p 5432:5432 \
  postgres:16-alpine

# Run migrations
pnpm db:push

# Start dev server
pnpm dev

Project Structure

src/
├── app/                 # Next.js pages and routes
├── components/          # React components
├── lib/                 # Utilities and services
├── server/api/routers/  # tRPC API routers
└── trpc/               # tRPC client config

Key Technologies

  • Next.js 16 - React framework with App Router
  • TypeScript - Type safety
  • Prisma - Database ORM
  • tRPC - End-to-end typesafe APIs
  • Tailwind CSS v4 - Styling

Questions?

Feel free to open an issue or reach out to the maintainers.

Thank you for contributing! 🎉