Skip to content

Commit e96a3d9

Browse files
TMHSDigitalclaude
andcommitted
chore: contributor experience (devcontainer, issue forms, FUNDING, CITATION)
- .devcontainer with Go 1.26 and golangci-lint v2.14.0; README gains an "Open in Codespaces" badge and CONTRIBUTING a Codespaces section. - Issue templates become YAML forms; config.yml disables blank issues and links to private vulnerability reporting, Q&A and Show and tell. - FUNDING.yml (GitHub Sponsors) and CITATION.cff. Discussions are enabled on the repository. Fixes #75 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 49d8fe3 commit e96a3d9

11 files changed

Lines changed: 150 additions & 62 deletions

File tree

‎.devcontainer/devcontainer.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"name": "subenum",
3+
"image": "mcr.microsoft.com/devcontainers/go:1.26-bookworm",
4+
"postCreateCommand": "go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.14.0 && go mod download && go build -o subenum . && echo 'Try: ./subenum -simulate example.com'",
5+
"customizations": {
6+
"vscode": {
7+
"extensions": ["golang.go"]
8+
},
9+
"codespaces": {
10+
"openFiles": ["README.md"]
11+
}
12+
}
13+
}

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [TMHSDigital]

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Bug report
2+
description: Something in subenum doesn't work as documented
3+
title: "[BUG] "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for the report. **Do not include sensitive information, unauthorized scan results, or private domain details you don't have permission to disclose.** Use `example.com` or a `-simulate` run where you can.
10+
11+
Found a security vulnerability? Report it privately instead: https://github.com/TMHSDigital/subenum/security/advisories/new
12+
- type: textarea
13+
id: what-happened
14+
attributes:
15+
label: What happened
16+
description: A clear description of the bug.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduce
21+
attributes:
22+
label: Steps to reproduce
23+
description: The exact command, and the wordlist size or content if it matters.
24+
placeholder: |
25+
subenum -simulate -w words.txt example.com
26+
render: shell
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: expected
31+
attributes:
32+
label: Expected behavior
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: output
37+
attributes:
38+
label: Output
39+
description: Terminal output, or the run-quality report from `-stats`.
40+
render: text
41+
- type: input
42+
id: version
43+
attributes:
44+
label: subenum version
45+
description: Output of `subenum -version`.
46+
placeholder: v0.8.0
47+
validations:
48+
required: true
49+
- type: input
50+
id: os
51+
attributes:
52+
label: Operating system
53+
placeholder: Ubuntu 24.04, Windows 11, macOS 15
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: context
58+
attributes:
59+
label: Additional context

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Report a security vulnerability
4+
url: https://github.com/TMHSDigital/subenum/security/advisories/new
5+
about: Please report vulnerabilities privately, not in a public issue.
6+
- name: Ask a question
7+
url: https://github.com/TMHSDigital/subenum/discussions/categories/q-a
8+
about: Usage questions and help with a scan.
9+
- name: Show and tell
10+
url: https://github.com/TMHSDigital/subenum/discussions/categories/show-and-tell
11+
about: Share how you use subenum in a lab, class or authorized engagement.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature request
2+
description: Suggest an idea for subenum
3+
title: "[FEATURE] "
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Features should fit subenum's educational and authorized-testing purpose. Suggestions that would mainly enable misuse may be declined. For open-ended ideas, start a [discussion](https://github.com/TMHSDigital/subenum/discussions) first.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem
14+
description: What are you trying to do, and what gets in the way?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Proposed solution
21+
description: What you'd like subenum to do.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: use-case
26+
attributes:
27+
label: Use case
28+
description: The authorized testing, defensive or teaching scenario this helps.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives considered
35+
- type: textarea
36+
id: implementation
37+
attributes:
38+
label: Implementation ideas (optional)

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [Unreleased]
99

1010
### Added
11+
- Contributor experience: a devcontainer (Go 1.26 plus the CI golangci-lint) with an "Open in Codespaces" badge, YAML issue forms with blank issues disabled and contact links to private vulnerability reporting and Discussions, `FUNDING.yml` and `CITATION.cff` (#75).
1112
- Encrypted DNS transports: `-dns-server tls://host[:853]` (DNS over TLS, with pooled connections) and `-dns-server https://host/path` (DNS over HTTPS, RFC 8484, keep-alive and HTTP/2). Records, outcome classification (including REFUSED and timeouts) and `-rate` accounting are identical to UDP, and the run-quality report gains a `transport` field (#86).
1213
- Resumable scans: an interrupted run (Ctrl+C, SIGTERM) saves its state to `subenum-resume.json` (or `-state <file>`), and `subenum -resume <file>` replays the original command line, checks the input files are unchanged, restores the earlier results and continues from the first wordlist entry not yet fully looked up. The scan engine tracks that low-water mark exactly even though workers finish out of order, so at most a worker pool's worth of lookups is repeated (#73).
1314
- Permutation mode: `-permute` follows each target's scan with a second pass over permutations of the names found (word joins such as `api-dev`, `dev-api` and `dev.api`, and number increments), and `-seeds <file>` adds seeds from an earlier run in any format. The pass is fully guarded (preflight, wildcard filtering, `-rate`, `-max-queries`, `-exclude`), skips wordlist entries, marks its hits `"permutation": true`, and reports seeds, candidates and hits in the run-quality report (#72).

‎CITATION.cff‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
cff-version: 1.2.0
2+
message: "If you use subenum in teaching or research, please cite it as below."
3+
title: subenum
4+
type: software
5+
authors:
6+
- name: "TM Hospitality Strategies"
7+
repository-code: "https://github.com/TMHSDigital/subenum"
8+
url: "https://tmhsdigital.github.io/subenum/"
9+
abstract: >-
10+
A Go subdomain enumeration tool for authorized security testing and
11+
teaching, with wildcard filtering, rate limiting, a run-quality report
12+
and a zero-network simulation mode.
13+
keywords:
14+
- dns
15+
- subdomain enumeration
16+
- security education
17+
- go
18+
license: GPL-3.0-only
19+
version: 0.8.0
20+
date-released: "2026-10-04"

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
[![Go Report Card](https://goreportcard.com/badge/github.com/TMHSDigital/subenum?style=for-the-badge)](https://goreportcard.com/report/github.com/TMHSDigital/subenum)
1313
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge)](./docs/CONTRIBUTING.md)
1414
[![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS%20%7C%20Windows-lightgrey?style=for-the-badge)](#installation)
15+
[![Open in GitHub Codespaces](https://img.shields.io/badge/Open%20in-Codespaces-181717?style=for-the-badge&logo=github)](https://codespaces.new/TMHSDigital/subenum)
1516

1617
<br>
1718

0 commit comments

Comments
 (0)