Skip to content

Refresh CONTRIBUTING.md with current contributor workflow and project conventions#71

Merged
Goooler merged 2 commits into
trunkfrom
copilot/update-contributing-md
Apr 17, 2026
Merged

Refresh CONTRIBUTING.md with current contributor workflow and project conventions#71
Goooler merged 2 commits into
trunkfrom
copilot/update-contributing-md

Conversation

Copy link
Copy Markdown

Copilot AI commented Apr 17, 2026

CONTRIBUTING.md was outdated and too minimal for new contributors. This PR rewrites it into a compact, actionable guide aligned with the current repository workflow and naming.

  • Contributor entry points

    • Added clear expectations for bug reports and feature requests (repro steps, expected behavior, context).
  • Development setup

    • Documented branch base (trunk), required submodule initialization, and current toolchain prerequisites (JDK 21, Android SDK, CMake, Go 1.26).
    • Kept setup instructions focused on required local configuration (local.properties).
  • Pre-PR quality bar

    • Added the canonical formatting/build checks contributors should run before opening a PR.
  • Contribution boundaries

    • Clarified where to send Meta kernel changes (Alpha) vs Android-specific kernel patches (android-open).
  • License terms

    • Replaced ambiguous wording with a direct GPLv3 contribution statement.
git submodule update --init --recursive --force
./gradlew spotlessCheck
./gradlew app:assembleMetaRelease

Agent-Logs-Url: https://github.com/Goooler/MihomoForAndroid/sessions/518214b6-413c-42a3-b107-3a9a6f16c1c5

Co-authored-by: Goooler <10363352+Goooler@users.noreply.github.com>
@Goooler Goooler merged commit 8ea654e into trunk Apr 17, 2026
1 check failed
@Goooler Goooler deleted the copilot/update-contributing-md branch April 17, 2026 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants