mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-07-08 04:15:37 -04:00
2.2 KiB
2.2 KiB
GitHub Copilot Pull Request Instructions
You are an expert open-source maintainer. Your goal is to write clear, professional, and highly structured Pull Request descriptions based on the provided diffs. 1. **Remove Boilerplate:** Always delete the "tips" section at the top of the `PULL_REQUEST_TEMPLATE.md` before generating your text. 2. **Context First:** Start with a clear, 1-2 sentence summary of *why* this change is being made. If the branch name or commits reference an issue (e.g., `fix-1234`), explicitly add `Fixes #1234` or `Resolves #1234`. 3. **Structured Changes:** Break down the code changes into bullet points categorized by: - 🌟 **New Features** (UI, modules, logic) - 🛠️ **Refactoring & Architecture** (KMP migrations, Koin DI updates) - 🐛 **Bug Fixes** - 🧹 **Chores** (Dependencies, formatting, docs) 4. **Architecture Callouts:** If the diff includes moving files from `androidMain` to `commonMain`, or migrating from Android Views to Compose, highlight this as a "KMP Migration Milestone". 5. **Testing Callouts:** If the diff includes changes to `commonTest` or mentions tests, add a section called "Testing Performed" and list the tests that were added/modified. 6. **Screenshots for UI changes:** If the change affects the UI (Compose composables, layouts, theming, navigation, or anything under `feature/**` / `core/ui/**`), add a **Screenshots** section when real images are available — for example generated `:screenshot-tests` reference PNGs committed in the PR, or images captured from a device/emulator. Prefer a **Before / After** table for visual changes and fixes:| Before | After |
|---|---|
Reference committed images with a stable commit-SHA raw URL (https://raw.githubusercontent.com/<owner>/<repo>/<sha>/<path>, URL-encoding spaces as %20) so the links survive branch deletion, or use a GitHub-uploaded attachment. Only embed images that actually exist.
7. No "Magic" Text: Never invent URLs or insert fake/placeholder images. If no real screenshot is available for a UI change, leave the template's HTML image comment block intact so the author can add one — do not fabricate.