Contributing to dev3000

February 4, 2026 · View on GitHub

Thank you for your interest in contributing to dev3000! This document provides guidelines and information for contributors.

Getting Started

Prerequisites

Node.js >= v22.12.0
pnpm package manager
Git

Development Setup

Fork and clone the repository

git clone https://github.com/your-username/dev3000.git
cd dev3000

Install dependencies
```
pnpm install
```
Run the development build
```
pnpm dev
```
Run tests
```
pnpm test
```
Lint your code
```
pnpm lint
```

Project Structure

dev3000/
├── src/              # Main source code
├── mcp-server/       # Model Context Protocol server
├── www/              # Web interface for log viewing
├── docs/             # Documentation
└── .github/          # GitHub workflows and configuration

Development Workflow

Create a new branch for your feature or bugfix:

git checkout -b feature/your-feature-name

git checkout -b fix/issue-number

Make your changes following the code style guidelines
Test your changes locally:
- Run the test suite: pnpm test
- Run the linter: pnpm lint
- Test manually with a sample project

Commit your changes with clear, descriptive messages:

git commit -m "feat: add new feature"

git commit -m "fix: resolve issue #123"

Push to your fork:

git push origin feature/your-feature-name

Open a Pull Request with:
- Clear description of changes
- Reference to any related issues
- Screenshots/recordings if applicable
- Test results

Code Style Guidelines

Follow the existing code style in the project
Use TypeScript for type safety
Run pnpm lint before committing
Write clear, self-documenting code
Add comments for complex logic

Commit Message Convention

We follow conventional commits for clear git history:

feat: - New features
fix: - Bug fixes
docs: - Documentation changes
style: - Code style changes (formatting, etc.)
refactor: - Code refactoring
test: - Adding or updating tests
chore: - Maintenance tasks

Examples:

feat: add support for Vite projects
fix: resolve port detection issue on Windows
docs: update installation instructions

Reporting Bugs

When reporting bugs, please include:

Environment details:
- dev3000 version
- Node.js version
- Package manager (pnpm/npm/yarn) and version
- Operating system
- Browser version (if applicable)
- Framework and version (e.g., Next.js 16.0.3)
Steps to reproduce the issue
Expected behavior vs actual behavior
Logs (from ~/.d3k/logs/ if available)
Screenshots or recordings if applicable