-
Notifications
You must be signed in to change notification settings - Fork 61
Contributing Guide
See the full CONTRIBUTING.md in the repository for detailed guidelines.
- Browse open issues — look for
good first issuelabels - Fork the repo and create a feature branch from
main - Implement the fix or feature (one issue per PR)
- Open a pull request referencing the issue number
-
Use AppSettings, never QSettings — all persistence via
AppSettings::instance() - Match the dark theme — copy colors from existing widgets
-
No feedback loops — use
QSignalBlockerwhen updating UI from model signals -
Multi-Flex safety — filter by
client_handle - One PR per issue — keep changes focused
- Test the RX chain — discovery → connect → FFT → audio must still work
See AI-Assisted Development for how to contribute using Claude AI.
The fastest path is Help → Support… inside AetherSDR — it builds a support bundle, copies an AI prompt to your clipboard, and opens GitHub's bug-report form. See Support and Logging for the detailed walk-through (logging categories, when to enable each, privacy notes).
If you'd rather file by hand, use the bug report template and include:
- What happened vs. what you expected
- Radio model and firmware version
- OS, distro, and Qt version
- Log file (
~/.config/AetherSDR/AetherSDR/aethersdr.log— see Support and Logging for macOS / Windows paths)
Click the lightbulb 💡 in AetherSDR's title bar (or use Help → Submit your idea… 💡) — it opens the AI-Assisted Issue Reporter which pastes a structured prompt into Claude, ChatGPT, Gemini, Grok, or Perplexity and lets you describe your idea in plain English; the AI writes the issue body for you.
If you'd rather file by hand, use the feature request template. The prompt the lightbulb uses is also documented in CONTRIBUTING.md.
- Panadapter Controls
- VFO Widget
- RX Controls
- TX Controls
- Aetherial Audio
- Multi-Slice Operation
- Diversity and ESC
- TNF (Tracking Notch Filters)
- Memory Channels
- Profile Management
- Slice Colors
- XVTR (Transverters)
- CWX Panel
- CW Decoder
- DVK Panel
- RTTY Operation
- RADE Digital Voice
- DAX Virtual Audio
- DAX IQ Streaming
- WSJT-X Integration
- CAT Control
- TCI Server