Kotlin / Kotlin/multiplatform-library-template

Incorporate best practices from the Library Authors' Guidelines

Open
#49 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
340
Forks
61
PR merge metrics
No merged PRs in 30d

Description

There are certain best practices listed in our official [Library Author's Guidelines](https://kotlinlang.org/docs/api-guidelines-introduction.html).

Those include using:
- `explicitApi()`
- binary compatibility validator
- writing documentation and samples, and using Dokka to render it

It would be nice to incorporate at least some of these practices to help developers creating production-quality libraries right of the bat.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked Library Authors' Guidelines and inspect the template's build configuration and documentation setup. Determine which of explicitApi(), the binary compatibility validator, documentation, samples, and Dokka are appropriate to incorporate; done means the selected practices are enabled and usable by developers creating libraries.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
developer-experience, documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.