CONTRIBUTING.md

Rama main · réplica de lectura del repositorio original.

# Contributing to HydraDNS

Thanks for your interest in contributing! HydraDNS is an open-source DNS security gateway and we welcome contributions of all kinds.

## Getting Started

### Prerequisites

- Go 1.26+
- Node.js 20+
- Docker & Docker Compose
- Make

### Development Setup

```bash
# Clone (single repo, no submodules)
git clone https://github.com/hydradns/hydradns.git
cd hydradns

# Start the full stack
make start

# Or work on individual services
cd apps/core && make build && make test
cd apps/ui && npm install && npm run dev
cd apps/cli && go build -o hydra .
```

## Repository Structure

This is a single monorepo. Each service lives under `apps/`:

| Service | Path |
|:--------|:-----|
| Core (control + data plane) | `apps/core` |
| Dashboard | `apps/ui` |
| Scanner | `apps/scanner` |
| CLI | `apps/cli` |

Work inside the relevant `apps/<service>` directory and open one pull request
against this repository. The landing site (hydradns.app) is maintained separately
at `hydradns/hydradns-landing`.

## Making Changes

1. Fork the relevant repository
2. Create a feature branch: `git checkout -b feature/my-change`
3. Make your changes
4. Run tests: `make test` (Go) or `npm run lint` (TypeScript)
5. Commit with a clear message describing the change
6. Push and open a pull request

## Code Style

### Go (Core, Scanner, CLI)

- Run `make fmt` before committing
- Run `make vet` and `make lint` (golangci-lint) to catch issues
- Write tests for new functionality
- Follow standard Go conventions (effective Go, Go Code Review Comments)

### TypeScript (Dashboard, Landing)

- Run `npm run lint` before committing
- Use TypeScript strict mode
- Prefer typed API responses over `any`

## What to Contribute

- Bug fixes (check issues for reported bugs)
- Test coverage improvements
- Documentation improvements
- New blocklist format parsers
- Dashboard UX improvements
- CLI commands for missing operations

## Reporting Issues

Open an issue on the relevant service repository with:
- What you expected to happen
- What actually happened
- Steps to reproduce
- Environment details (OS, Docker version, etc.)

## License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.