Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (62 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

79 lines (62 loc) · 1.92 KB

Contributing to WaldTeX

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

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/<your-username>/waldtex.git
cd waldtex
  3. Install dependencies: 
    npm install
  4. Start the dev server: 
    npm run dev
    This starts both the backend and frontend with hot reload.

Development Workflow

  1. Create a branch from main: 
    git checkout -b feature/your-feature-name
  2. Make your changes.
  3. Run lint and type checks: 
    npm run lint
npm run typecheck
  4. Commit with a clear message describing what changed and why.
  5. Push to your fork and open a Pull Request against main.

Code Style

  • TypeScript for all source files.
  • 2 spaces for indentation (enforced by .editorconfig).
  • No semicolons — we use the default Prettier/ESLint style.
  • Keep files focused — one component per file, one service per file.
  • Prefer named exports over default exports.

Project Structure

src/
  server/        # Express + WebSocket backend
    routes/      # REST API endpoints
    services/    # Business logic
  client/        # React frontend
    components/  # UI components
    hooks/       # React hooks
    stores/      # Zustand state stores
    styles/      # CSS / Tailwind

Reporting Bugs

Open an issue on GitHub with:

  • A clear title and description
  • Steps to reproduce the bug
  • Expected vs actual behavior
  • Your OS, Node.js version, and Quarto version

Requesting Features

Open an issue with the enhancement label. Describe:

  • What problem the feature solves
  • How you envision it working
  • Any alternatives you considered

License

By contributing, you agree that your contributions will be licensed under the MIT License.