Skip to content

Commit b824e95

Browse files
jaspermayonejaspermayone
committed
dox
1 parent 02c3fb9 commit b824e95

4 files changed

Lines changed: 175 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug Report
3+
about: Report an issue with DNS configuration or tooling
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
<!-- A clear description of what the bug is -->
11+
12+
## Domain Affected
13+
- [ ] patchworklabs.org
14+
- [ ] hackathon.help
15+
- [ ] Both domains
16+
- [ ] Tooling/Scripts
17+
18+
## Expected Behavior
19+
<!-- What you expected to happen -->
20+
21+
## Actual Behavior
22+
<!-- What actually happened -->
23+
24+
## Steps to Reproduce
25+
1.
26+
2.
27+
3.
28+
29+
## DNS Lookup Results
30+
<!-- If relevant, include output from dig, nslookup, or online DNS tools -->
31+
```
32+
# Paste DNS lookup results here
33+
```
34+
35+
## Environment
36+
- **Command used:** (dry-run, sync, etc.)
37+
- **Error message:** (if any)
38+
- **OctoDNS version:** (if known)
39+
40+
## Additional Context
41+
<!-- Screenshots, logs, or other relevant information -->

‎.github/ISSUE_TEMPLATE/dns-change-request.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: DNS Change Request
3+
about: Request a DNS record change or addition
4+
title: '[DNS] '
5+
labels: dns-change
6+
assignees: ''
7+
---
8+
9+
## Domain
10+
- [ ] patchworklabs.org
11+
- [ ] hackathon.help
12+
13+
## Change Type
14+
- [ ] Add new record
15+
- [ ] Modify existing record
16+
- [ ] Delete record
17+
- [ ] TTL change only
18+
19+
## Record Details
20+
**Record Type:** (A, AAAA, CNAME, MX, TXT, etc.)
21+
**Name:** (subdomain or @ for root)
22+
**Value:** (IP address, domain name, or text value)
23+
**TTL:** (in seconds, see CLAUDE.md for standards)
24+
25+
## Current Record (if modifying/deleting)
26+
```
27+
# Paste current record configuration here
28+
```
29+
30+
## Business Justification
31+
<!-- Why is this change needed? Reference any related projects, services, or requirements -->
32+
33+
## Impact Assessment
34+
- [ ] This change affects email routing
35+
- [ ] This change affects website availability
36+
- [ ] This change affects third-party integrations
37+
- [ ] This is a low-risk change
38+
39+
## Testing Plan
40+
- [ ] I will verify the change using DNS lookup tools
41+
- [ ] I will test affected services after the change
42+
- [ ] This change requires coordination with other teams
43+
44+
## Rollback Plan
45+
<!-- How can this change be reverted if needed? -->
46+
47+
## Additional Context
48+
<!-- Any additional information, screenshots, or references -->

‎.github/pull_request_template.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
1+
## DNS Changes Summary
2+
<!-- Brief description of what DNS records are being changed -->
13

4+
## Domain(s) Affected
5+
- [ ] patchworklabs.org
6+
- [ ] hackathon.help
7+
8+
## Change Type
9+
- [ ] Add new records
10+
- [ ] Modify existing records
11+
- [ ] Delete records
12+
- [ ] TTL adjustments
13+
- [ ] Configuration changes
14+
15+
## Records Changed
16+
<!-- List each record change in detail -->
17+
| Record Type | Name | Old Value | New Value | TTL | Reason |
18+
|-------------|------|-----------|-----------|-----|--------|
19+
| | | | | | |
20+
21+
## Business Justification
22+
<!-- Why are these changes needed? Reference issues, projects, or requirements -->
23+
24+
## Pre-Deployment Checklist
25+
- [ ] Ran `./bin/dry-run` to preview changes
26+
- [ ] Verified YAML syntax is valid
27+
- [ ] Checked TTL values follow standards in CLAUDE.md
28+
- [ ] Documented critical records with inline comments
29+
- [ ] Confirmed no sensitive information in commit
30+
- [ ] Verified changes don't break existing services
31+
32+
## Testing Plan
33+
- [ ] DNS propagation will be monitored after deployment
34+
- [ ] Affected services will be tested post-deployment
35+
- [ ] Rollback plan is documented below
36+
37+
## Rollback Plan
38+
<!-- How to revert these changes if needed -->
39+
40+
## Related Issues
41+
<!-- Link to any related GitHub issues -->
42+
Closes #
43+
44+
## Additional Notes
45+
<!-- Any other relevant information -->

‎CLAUDE.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,48 @@ export HETZNER_KEY=your_hetzner_api_key
3737
- **Zone Sources**: Both domains use YAML provider as source and Hetzner as target
3838
- **DNS Records**: Defined in domain-specific YAML files with standard DNS record types (MX, TXT, CNAME, etc.)
3939

40+
## TTL Management Standards
41+
42+
Use appropriate TTL values based on record type and change frequency:
43+
44+
- **A/AAAA Records**: 300 seconds (5 minutes) for frequently changing IPs, 3600 seconds (1 hour) for stable services
45+
- **CNAME Records**: 3600 seconds (1 hour) standard, 300 seconds for testing/development
46+
- **MX Records**: 3600 seconds (1 hour) - email routing should be stable
47+
- **TXT Records**:
48+
- Verification records (Google, etc.): 86400 seconds (24 hours) - rarely change
49+
- SPF/DMARC: 3600 seconds (1 hour) - may need adjustments
50+
- General purpose: 3600 seconds (1 hour)
51+
- **NS Records**: 86400 seconds (24 hours) - nameservers change infrequently
52+
53+
### TTL Guidelines
54+
- Lower TTLs (300-900s) for records under active development or testing
55+
- Higher TTLs (3600-86400s) for stable, production records
56+
- Always consider propagation time vs. flexibility trade-offs
57+
- Document TTL choices for critical records with inline comments
58+
59+
## Documentation Standards
60+
61+
### YAML File Documentation
62+
- Add comments above critical record groups explaining their purpose
63+
- Document any non-standard configurations or complex setups
64+
- Include references to external services (Google Workspace, email providers)
65+
- Use consistent formatting and indentation
66+
67+
### Change Documentation
68+
- All DNS changes should include clear commit messages explaining the business purpose
69+
- Reference related tickets, issues, or requests in commit messages
70+
- Document TTL changes and reasoning in commit messages
71+
72+
### Record Comments Format
73+
```yaml
74+
# Google Workspace email routing - DO NOT MODIFY without IT approval
75+
mx:
76+
values:
77+
- exchange: mx1.example.com
78+
priority: 10
79+
ttl: 3600
80+
```
81+
4082
## Important Notes
4183
4284
- Always run dry-run commands before applying changes to preview DNS modifications

0 commit comments

Comments
 (0)