Skip to content

Commit 940dcf8

Browse files
TMHSDigitalclaude
andcommitted
docs(contributing): runnable Docker and Windows race commands (#227)
make docker-run without DOMAIN always fails on require-domain; show make docker-simulate and make docker-run DOMAIN=... instead. Give the Windows-only GOTOOLCHAIN workaround in PowerShell form as well, in CONTRIBUTING and DEVELOPER_GUIDE. Link the Code of Conduct as .md so it resolves on GitHub too, and use an absolute CONTRIBUTING link in the PR template, where relative links 404. Fixes #227 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 1382073 commit 940dcf8

3 files changed

Lines changed: 19 additions & 4 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
## Checklist
1818
<!-- Please mark the relevant option with an 'x' -->
19-
- [ ] I have read the [CONTRIBUTING](../docs/CONTRIBUTING.md) document
19+
- [ ] I have read the [CONTRIBUTING](https://github.com/TMHSDigital/subenum/blob/main/docs/CONTRIBUTING.md) document
2020
- [ ] My code follows the code style of this project
2121
- [ ] I have added/updated appropriate comments to the code
2222
- [ ] I have added tests that prove my fix is effective or that my feature works

‎docs/CONTRIBUTING.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Contributing
77

88
We welcome contributions! Please read this guide to understand how you can contribute.
99

10-
See the [Code of Conduct](CODE_OF_CONDUCT.html).
10+
See the [Code of Conduct](CODE_OF_CONDUCT.md).
1111

1212
## Development Environment Setup
1313

@@ -77,8 +77,11 @@ You can use Docker for development to ensure a consistent environment:
7777
# Build the Docker image
7878
make docker-build
7979

80-
# Run the tool in a Docker container
81-
make docker-run
80+
# Simulated scan in a container (no DNS traffic)
81+
make docker-simulate
82+
83+
# Live scan in a container: name a domain you own or may test
84+
make docker-run DOMAIN=yourdomain.com
8285
```
8386

8487
## Pull Request Process
@@ -168,6 +171,12 @@ per command:
168171
GOTOOLCHAIN=go1.26.3 go test -race ./...
169172
```
170173

174+
In PowerShell:
175+
176+
```powershell
177+
$env:GOTOOLCHAIN = "go1.26.3"; go test -race ./...; Remove-Item Env:GOTOOLCHAIN
178+
```
179+
171180
New features should include tests. New flags must be covered by at least one test case.
172181
Do not hit public resolvers. Use `-simulate` or the in-process DNS server in
173182
`internal/dnstest`, which answers from a per-query handler (records, RCODE,

‎docs/DEVELOPER_GUIDE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,12 @@ per command:
207207
GOTOOLCHAIN=go1.26.3 go test -race ./...
208208
```
209209

210+
In PowerShell:
211+
212+
```powershell
213+
$env:GOTOOLCHAIN = "go1.26.3"; go test -race ./...; Remove-Item Env:GOTOOLCHAIN
214+
```
215+
210216
Default `go test ./...` is hermetic (in-process DNS responder, no outbound
211217
network). The optional live resolver smoke test is gated on an env var:
212218

0 commit comments

Comments
 (0)