114 lines (84 loc) · 2.24 KB

Contributing to DNSWeaver

Thank you for your interest in contributing to DNSWeaver!

Development Setup

Prerequisites

Go 1.24 or later
Docker (for testing)
Access to a Docker Swarm cluster (optional, for integration testing)

Getting Started

Clone the repository:

git clone https://github.com/maxfield-allison/dnsweaver.git
cd dnsweaver

Install dependencies:
```
go mod download
```
Build:
```
go build -o dnsweaver ./cmd/dnsweaver
```
Run tests:
```
go test -v ./...
```

Branching Strategy

We follow GitFlow:

Branch	Purpose
`main`	Stable releases only (tagged)
`develop`	Integration branch
`feature/*`	New features
`bugfix/*`	Bug fixes
`hotfix/*`	Urgent production fixes

Branch Naming

feature/[issue-number]-short-description
bugfix/[issue-number]-short-description
hotfix/[issue-number]-short-description

Example: feature/21-multi-provider-design

Commit Messages

We use Conventional Commits:

type(scope): description

[optional body]

[optional footer]

Types:

feat: New feature
fix: Bug fix
docs: Documentation only
style: Formatting, no code change
refactor: Code change that neither fixes a bug nor adds a feature
perf: Performance improvement
test: Adding tests
build: Build system or dependencies
ci: CI/CD changes
chore: Other changes

Examples:

feat(provider): add Cloudflare DNS provider
fix(reconciler): handle empty hostname list
docs: update configuration reference

Code Style

Use gofmt for formatting
Use golangci-lint for linting
Follow Effective Go
Add comments for exported functions, types, and packages

Testing

Write table-driven tests
Test behavior, not implementation
Aim for meaningful coverage, not 100%
Mock external dependencies (Docker, DNS APIs)

Pull Request Process

Create a feature branch from develop
Make your changes with tests
Ensure CI passes
Create a merge request to develop
Address review feedback
Squash and merge

Questions?

Open an issue or reach out to the maintainers.