mirror of
https://github.com/portapack-mayhem/mayhem-firmware.git
synced 2026-08-12 10:53:42 +00:00
未来方舟
70 lines
4.0 KiB
Markdown
70 lines
4.0 KiB
Markdown
<!--
|
|
👋 Thank you for your contribution!
|
|
|
|
⚠️ Before you start, please review our Contributing Guidelines:
|
|
https://github.com/portapack-mayhem/mayhem-firmware/wiki/Contributing-Guidelines
|
|
-->
|
|
|
|
## Brief description of what you did
|
|
|
|
<!-- Replace this line with a description of your changes. What problem does this PR solve? What does it add or fix?
|
|
Don't forget to describe how maintainers can test your modifications! -->
|
|
|
|
---
|
|
|
|
## 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 contributor` with a short note. First-time contributors must provide full proof. See the [Contributing Guidelines](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Contributing-Guidelines) and [Trusted Contributors](https://github.com/portapack-mayhem/mayhem-firmware/wiki/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 % )`.
|
|
|
|
<!-- Paste log below -->
|
|
|
|
### 📱 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.**
|
|
|
|
<!-- Paste photo / video / screenshot below -->
|
|
|
|
### 📡 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.
|
|
|
|
<!-- Paste RF evidence, or write N/A with a short justification -->
|
|
|
|
---
|
|
|
|
## 📚 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](https://github.com/portapack-mayhem/mayhem-firmware/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)
|
|
- [ ] I own all rights to this code (i.e., all code contained in this PR), including compliant usage rights for third-party libraries, and I agree that this code is licensed under the license of this project (GPL-3.0).
|
|
- [ ] If any third-party libraries are used, I confirm that their licenses comply with the requirements for contributing to this repository.
|
|
- [ ] Reviewed the [Contributing Guidelines](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Contributing-Guidelines)
|