Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.08 KB

README.md

File metadata and controls

43 lines (31 loc) · 2.08 KB

KFIP - Koin Features & Improvements Proposals

Starting from Koin 4.x, all significant changes to the framework will pass through this repository for an initial review of the design before implementation.

This repository is inspired from Kotlin KEEP and Ktor KLIP initiatives

The goal of this process is to promote transparency and collaboration in the development of the framework, as in the spirit of the Request of Comments (RFC) process developed by the Internet Engineering Task Force (IETF).

Proposals

  • New proposals are submitted as pull requests.
  • When proposals are implemented, the corresponding design documents are merged into this repository and stored in a proposals directory.

Contributing

We are always interested in new ideas for improving Koin. Not every idea needs to be reviewed here, nor do we expect submissions for the changes that do warrant consideration.

Enhancements/features usually go through the following informal stages:

  • Discussion of an idea.
  • Collection of use-cases.
  • Design proposal and prototype implementation.
  • Experimental support in the framework.
  • Further refinement and stable release.

Generally, all that's required is reaching us on #koin-contributors, or submitting an issue on Github Issue.

If you're more interested in making major contributions to the framework, then here is the place where you can submit your proposals.

To submit a proposal:

  1. Fork this repository
  2. Copy the template.md into the proposals directory under an appropriate filename.
  3. Fill in all the relevant details for the proposal, as described in the template.
  4. Create a pull request with the new proposal.
  5. Wait for a review and the acceptance of your proposal.

After a proposal is accepted, it will be ready to be implemented into Koin.