Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (43 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 1.23 KB

Contributing

Thanks for your interest in contributing to Dokploy CLI!

Before you start, please discuss the feature/bug via GitHub issues.

Setup

git clone https://github.com/Dokploy/cli.git
cd cli
pnpm install

Create a .env file with your credentials:

DOKPLOY_URL="https://your-server.dokploy.com"
DOKPLOY_API_KEY="YOUR_API_KEY"

Development

# Run in dev mode
pnpm run dev -- project all

# Regenerate commands from OpenAPI spec
pnpm run generate

# Build
pnpm run build

# Lint & format
pnpm run lint

Updating commands

Commands in src/generated/commands.ts are auto-generated from openapi.json. Never edit that file manually. To update:

  1. Replace openapi.json with the latest spec from the Dokploy repo
  2. Run pnpm run generate

Commit convention

Follow Conventional Commits:

feat: add new feature
fix: resolve bug
docs: update readme
chore: bump version

Pull requests

  • Branch from main
  • Provide a clear description of your changes
  • Reference any related issues
  • Include a screenshot/video if applicable

Thank you for your contribution!