microg / microg/GmsCore

Internals documentation

Open
#244 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

confirmed
Dominant language
Java
Stars
14.6k
Forks
3.2k
Avg merge
12d 11h
Merged PRs (30d)
4

Description

So, I'm eager to contribute to microG. There's just one problem: I've spent the last 10 hours trying to decipher the codebase, and feel like I'm nonethewiser for it. Could you please please PLEASE add some documentation? At least the architecture? I understand that nobody likes writing docs, and I understand that much of the structure is forced upon you by having to copy GPS, but it's critical if people are going to make any substantial contribution.

<3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name any files, tests, or entry points. Start by surveying the repository structure and existing documentation to identify the major components and their relationships; done means adding an agreed architecture overview that makes the codebase easier for contributors to navigate.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java
Domain
documentation, mobile-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.