https://github.com/kotlin/api-guidelines

Best practices to consider when writing an API for your library
https://github.com/kotlin/api-guidelines

api documentation guidelines kotlin library

Last synced: 6 months ago
JSON representation

Best practices to consider when writing an API for your library

• Host: GitHub
• URL: https://github.com/kotlin/api-guidelines
• Owner: Kotlin
• License: apache-2.0
• Created: 2023-03-15T13:30:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-06-23T15:52:27.000Z (7 months ago)
• Last Synced: 2025-07-02T05:46:51.784Z (6 months ago)
• Topics: api, documentation, guidelines, kotlin, library
• Homepage: https://kotl.in/api-guide
• Size: 2.95 MB
• Stars: 152
• Watchers: 12
• Forks: 21
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![official JetBrains project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

# Kotlin API guidelines

This guide contains a summary of best practices as well as some ideas to consider when writing an API for your library.

The guide is mostly authored by the Kotlin Libraries team, and is based on the practices the team follows when developing and maintaining Kotlin standard and official libraries.

You can read it at [kotl.in/api-guide](https://kotl.in/api-guide)

## Discussion

You are welcome to join the discsussion about existing guidelines

or to propose a new one. Feel free to join the [discussions](https://github.com/Kotlin/api-guidelines/discussions) or

submit your requests to [issues](https://github.com/Kotlin/api-guidelines/issues/).

## Contributing

See [Contribution Guidelines](CONTRIBUTING.md)