Skip to content

Commit a1cb3db

Browse files
committed
docs: add contributing guide
1 parent 1bdc8c3 commit a1cb3db

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to devproxy
2+
3+
Thanks for your interest in contributing!
4+
5+
## Reporting bugs
6+
7+
Open an issue using the **Bug report** template. Include:
8+
9+
- What happened and what you expected
10+
- Steps to reproduce
11+
- Output of `devproxy doctor` and relevant daemon logs
12+
- Your OS, Docker version, and devproxy version
13+
14+
## Suggesting features
15+
16+
Open an issue using the **Feature request** template. Describe the problem you're trying to solve and your proposed solution.
17+
18+
## Submitting PRs
19+
20+
1. Fork the repo and create a branch from `main`
21+
2. Make your changes
22+
3. Run tests: `go test ./internal/... ./cmd/... -v`
23+
4. Run vet: `go vet ./...`
24+
5. Open a PR against `main`
25+
26+
### Requirements
27+
28+
- All tests must pass
29+
- New functionality should include tests
30+
- Keep changes focused — one concern per PR
31+
32+
### Building
33+
34+
```bash
35+
# With Nix
36+
nix build
37+
38+
# With Go
39+
go build -o devproxy ./cmd/devproxy
40+
```
41+
42+
### Running tests
43+
44+
```bash
45+
# Unit tests
46+
go test ./internal/... ./cmd/...
47+
48+
# Integration tests (requires Docker + root)
49+
sudo go test -tags=integration ./integration/ -v
50+
```
51+
52+
## Code of conduct
53+
54+
Be respectful. We're all here to build something useful.

0 commit comments

Comments
 (0)