-
-
Notifications
You must be signed in to change notification settings - Fork 13
Description
Type of Documentation
New Documentation (doesn't exist yet)
Current Documentation Location
Currently missing. Proposed location: docs/troubleshooting/
Description of Need
Clear and accessible troubleshooting documentation is needed to capture non-obvious problems, debugging steps, and complex workarounds that have surfaced while integrating tools like just, addlicense, and pre-commit. These issues often require significant time to investigate and solve, and without documentation, future contributors (including ourselves) may repeat the same work.
This documentation will:
- Save time for current and future contributors.
- Serve as internal memory for long-term maintainers.
- Lower the entry barrier for external open-source contributors.
Suggested Content
docs/troubleshooting/
Inside, add one Markdown file per tool or problem domain:
cross-platform-issues.md
docker-feature.md
warning-ci/cd.md
changelog-disable.md
codecov-feature.md
Each file should follow this outline:
# Troubleshooting: [Topic Name]
## 🧩 Issue Summary
## 🔍 Root Cause / Investigation
## 🛠️ Solution
## ⚠️ Non-obvious Details / Gotchas
## 🧪 How to Test or Reproduce
## 💬 Extra Notes
Link this section in README.md or CONTRIBUTING.md for visibility.
Contribution Willingness
Yes, I'm willing to contribute
Contact Information
No response
Pre-submission Confirmation
Yes