fritz2 icon indicating copy to clipboard operation
fritz2 copied to clipboard

Evaluate and establish an idiomatic Naming Convention for Filenames

Open ghost opened this issue 3 years ago • 1 comments

We should evaluate which naming conventions for source filenames in Kotlin exist and apply those stricly within our project. Without beeing specific for multiplatform projects, there is an official section within the style guide for Kotlin: https://kotlinlang.org/docs/coding-conventions.html#source-file-names

As we target different platforms, there might be good reasons to adapt another one or have different conventions for different source sets:

  • PascalCase for jvmMain etc
  • camelCase for the rest

But how to deal for hybrid sources like in commonMain?

Goal and Result

  • All these decisions should be chosen carefully and based upon external opinions if somehow possible!
  • Also the decisions should be documented and linked, so that everybody can reason about in the future.
  • It might be a good idea to explictly encourage fritz2 users to follow our scheme within their applications by adding appropriate sections to our (external) documentation.
  • all our sources including demo projects should adapt these conventions

ghost avatar Mar 15 '21 11:03 ghost

As time goes by the Kotlin coding conventions got stricter an now there is the convention for PascalCaseNames: https://kotlinlang.org/docs/coding-conventions.html#source-file-names

So we should follow this guideline!

Lysander avatar Nov 14 '23 15:11 Lysander

Closed in favor of #860!

Lysander avatar Apr 19 '24 09:04 Lysander