gullradriel
3f10663bc9
* update PR template * wiki mention * added trusted contributors guidelines, compile proof simplification
3.6 KiB
Brief description of what you did
Proof that your changes work
⚠️ PRs without proof will not be merged. Please provide evidence for every section below that applies to your change.
🛈 Trusted contributors: If you have a track record of merged PRs that were properly tested and documented, maintainers may waive one or more of the proof sections below at their discretion. You are still encouraged to include whatever evidence you have, but sections may be marked
N/A — trusted contributorwith a short note. First-time contributors must provide full proof. See the Contributing Guidelines and Trusted Contributors articles for details.
🖥️ Proof it compiles
Attach a log snippet showing a successful build from the final firmware size/space summary in the build output. Example: Space remaining in flash ROM: 19552 bytes ( 1.9 % ).
📱 Proof of testing on a real device
Attach photos, screenshots, or a short video of your changes running on actual PortaPack hardware. Emulator or simulator output is not a substitute for real-device testing.
📡 Proof against a real emitter/receiver (if applicable)
If your PR involves RX/TX, protocol decoding, signal generation, or any RF-related functionality, you must demonstrate it working against a real emitter or receiver. Include photos, videos, logs, or waterfall/spectrum screenshots.
If this section does not apply to your PR, write N/A below and briefly explain why.
📚 Wiki documentation commitment
By submitting this PR, you acknowledge that once it is merged you are responsible for creating or updating the corresponding page on the project wiki.
Your wiki article should include:
- A screenshot of the main app screen (strongly recommended)
- A clear description of what the app does
- An explanation of the controls and UI elements
- Any known limitations, quirks, or caveats
- Anything else a user should know to use the app effectively (dependencies, required hardware, file formats, etc.)
If you are modifying an existing app, make sure the wiki page reflects your changes.
Checklist
- Kept changes minimal and limited to necessary files
- Verified functionality remains intact and code compiles
- Attached proof that the code compiles successfully (or marked N/A as a trusted contributor)
- Attached proof of testing on real PortaPack hardware (or marked N/A as a trusted contributor)
- Attached proof of testing against a real emitter/receiver (if RF-related), or marked N/A with justification
- I understand that by getting this PR merged, I am implicitly agreeing to create or update the corresponding wiki page (including a main-screen screenshot, description, controls, and limitations)
- Reviewed the Contributing Guidelines