Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 2.14 KB

Contributing to Create Ryuu App

Thanks for your interest in contributing to Create Ryuu App! We're excited to have you join us. This document outlines the process and guidelines for contributing.

Getting Started

  1. Fork the Repository

  2. Clone Your Fork:

git clone [email protected]:YOUR_USERNAME/create-ryuu-app.git
  1. Install Dependencies:
pnpm install
  1. Create a Branch:
git checkout -b feat/something-awesome

Development Workflow

Please read our development guide for detailed information about:

  • Setting up your development environment
  • Running tests
  • Code style and conventions
  • Monorepo structure

Pull Request Process

We follow a structured process for contributions. See our Pull Request Guide for details.

Notable Features

  • 🏗️ Full type-safety with strict type checking
  • 📦 PNPM for fast, disk-efficient package management
  • 🏃 Turborepo for high-performance build system
  • 🔒 Environment variable validation using t3-env
  • 📝 ESLint & Prettier for consistent code style
  • 🧪 Testing setup with Vitest
  • 🚀 CI/CD with GitHub Actions

Code Style

We use strict TypeScript and follow modern React practices:

  • Use TypeScript to the fullest extent
  • Follow React 19 best practices
  • Use proper component typing
  • Prefer function over const for components (unless single-line return)
  • Use ESLint and Prettier for code formatting

Testing

All new features should include tests:

  • Integration tests for all tRPC routes

Documentation

For any new features or changes:

  1. Update relevant documentation in the apps/docs directory
  2. Add inline documentation for complex logic
  3. Update README if adding new features or changing setup steps

Need Help?

License

By contributing to Create Ryuu App, you agree that your contributions will be licensed under its MIT license.