micronaut-projects / micronaut-core

Micronaut Application Framework
http://micronaut.io
Apache License 2.0
6.08k stars 1.07k forks source link

Document guidelines for third-party modules #3849

Open donbeave opened 4 years ago

donbeave commented 4 years ago

Hello, guys!

Amazing work! I'll call Micronaut as a bombastic framework. ))

I have a small question, regarding naming for third party modules for Micronaut. It looks like all official modules come with prefix "micronaut-", like micronaut-security, micronaut-hibernate-jpa, micronaut-graphql. How about third-party modules, is there any suggestion, is it better follow this approach or use another naming strategy? Something like what is accepted for Spring Boot, they suggested in the official documentation all the starters which are not managed by the core Spring Boot team should start with the library name followed by the suffix "-spring-boot-starter" (azure-spring-boot-starter, ...), and official libraries are using "spring-boot-starter-" prefix (spring-boot-starter-undertow, spring-boot-starter-security, ...).

jameskleeh commented 4 years ago

@donbeave That convention makes sense to me. Thanks for asking! I'll leave this issue open to add as a task for documenting guidelines around creating third party modules