Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Clarify documentation around module construction methods

Open
#62 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
kotlin
Domain
documentation

Research direction

Read MODULARIZATION.md and the inline module-loader documentation to identify the existing description of construction without custom configuration. Clarify the supported public no-arg constructor, Kotlin object, and Java-like singleton approaches, including the remaining static detail shown in the issue. Done means both documentation locations consistently explain these approaches.

Written by the indexing model from the issue text.

Description

We should clarify the inline docs and https://github.com/mapbox/mapbox-base-android/blob/master/MODULARIZATION.md to make it clear what types of approaches will the module loader attempt when creating the object without a custom configuration. This means clarifying that it's compatible with:

  • class with a public, no-arg constructor
  • Kotlin object
  • Java-like singleton with a static
Dominant language
Kotlin
Stars
12
Forks
6
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from mapbox/mapbox-base-android

All issues in mapbox/mapbox-base-android

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.