Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (46 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 2.27 KB

Contributing

Note

Make sure to follow the system requirements specified in package.json#engines before proceeding.

Welcome! This is a quick reference guide. For detailed documentation, visit the Development docs.

Prerequisites

  • Node.js ^22.21.0
  • PNPM ^10.19.0
  • Bun ^1.3.0 (used for the TypeScript scripts that power docs and style)

Quick start

  1. Clone and setup:

    git clone https://github.com/techwithanirudh/coolify-tweaks.git
cd coolify-tweaks
pnpm install
cp .env.example .env

  2. Run the apps:

    pnpm dev

  3. Before pushing:

    pnpm lint
pnpm format
pnpm typecheck
pnpm check:spelling

Repository structure

Coolify Tweaks is a Turborepo monorepo with:

  • apps/ - Style (Sass pipeline), API (Nitro server), Docs (Next.js site)
  • packages/ - Shared packages (@repo/ui, @repo/validators)
  • tooling/ - Shared configs (ESLint, Prettier, Tailwind, TypeScript, cspell)

All internal packages are scoped under @repo/*.

Learn more

For detailed guides on working with each app, see the Development documentation:

  • Getting started - Prerequisites, repository layout, and quick start
  • Style app - Working with the Sass pipeline
  • API app - Working with the Nitro API
  • Docs app - Working with the documentation site
  • Tooling - Shared configuration packages

Commits and PRs

  • Branch names: Use descriptive names like feat/new-theme-toggle, fix/docs-typo
  • Commits: Follow Conventional Commits (feat:, fix:, docs:, chore:)
  • PRs: Keep them focused and ensure all checks pass

Need help?

If you get stuck, open an issue or a draft PR with what you tried and any error output.