Sage_Software/2002-Chevy-Express-3500
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add timestamp requirements to ISSUE_TEMPLATE.md

Browse Source 
- Require full YYYY-MM-DD HH:MM timestamps for all diagnostic entries
- Add timestamp columns to test result tables
- Add session log guidelines for tracking multi-day issues
- Helps with troubleshooting timeline and pattern recognition
This commit is contained in:
John Loper II
2026-03-21 21:05:57 -04:00
parent 942b064586
commit f65e1b24a4
1 changed files with 25 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ISSUE_TEMPLATE.md
+25 -12
View File
@@ -43,19 +43,21 @@
## 📊 Diagnostic Findings
**NOTE: All diagnostic steps and actions MUST include full timestamps (YYYY-MM-DD HH:MM) for tracking progress across multiple days.**
### Initial Inspection Results
- [x] [Inspection item 1 - e.g., Fluid level low]
- [x] [Inspection item 2 - e.g., No visible leaks]
- [ ] [Inspection item 3 - e.g., Check pressure]
- [ ] [Inspection item 4 - e.g., Test electrical]
- [x] [Inspection item 1 - e.g., Fluid level low] **[@YYYY-MM-DD HH:MM]**
- [x] [Inspection item 2 - e.g., No visible leaks] **[@YYYY-MM-DD HH:MM]**
- [ ] [Inspection item 3 - e.g., Check pressure] **[@YYYY-MM-DD HH:MM]**
- [ ] [Inspection item 4 - e.g., Test electrical] **[@YYYY-MM-DD HH:MM]**
### Test Results
| Test | Expected | Actual | Status |
|------|----------|--------|--------|
| [Test 1] | [Expected value] | [Actual reading] | ✅/❌/⚠️ |
| [Test 2] | [Expected value] | [Actual reading] | ✅/❌/⚠️ |
| [Test 3] | [Expected value] | [Actual reading] | ✅/❌/⚠️ |
| Test | Expected | Actual | Status | Tested At (YYYY-MM-DD HH:MM) |
|------|----------|--------|--------|------------------------------|
| [Test 1] | [Expected value] | [Actual reading] | ✅/❌/⚠️ | [YYYY-MM-DD HH:MM] |
| [Test 2] | [Expected value] | [Actual reading] | ✅/❌/⚠️ | [YYYY-MM-DD HH:MM] |
| [Test 3] | [Expected value] | [Actual reading] | ✅/❌/⚠️ | [YYYY-MM-DD HH:MM] |
### Diagnostic Data Collected
- **[Test 1]:** [Results and conclusions]
@@ -216,9 +218,20 @@
## 📅 Session Log
- **[YYYY-MM-DD]:** [Event description - e.g., "Project initiated, diagnosis started"]
- **[YYYY-MM-DD]:** [Event description - e.g., "Root cause identified, parts ordered"]
- **[YYYY-MM-DD]:** [Event description - e.g., "Repair completed, van running fine"]
**IMPORTANT: All entries MUST include full timestamps (YYYY-MM-DD HH:MM) to track issue progress across multiple days.**
- **[YYYY-MM-DD HH:MM]:** [Event description - e.g., "Project initiated, diagnosis started"]
- **[YYYY-MM-DD HH:MM]:** [Event description - e.g., "Diagnostic tests completed, root cause identified"]
- **[YYYY-MM-DD HH:MM]:** [Event description - e.g., "Parts ordered, awaiting delivery"]
- **[YYYY-MM-DD HH:MM]:** [Event description - e.g., "Repair completed, van running fine"]
**Session Log Guidelines:**
- Use full timestamp format: YYYY-MM-DD HH:MM (24-hour format)
- Include timestamp for EVERY action, test, and decision
- Track when parts were ordered, received, and installed (may span multiple days)
- Note when tests were performed and results observed
- Record when vehicle was test-driven and any issues found
- This enables accurate troubleshooting timeline and pattern recognition across multiple days
---