search

fulcrumgenomics / fgbio

Tools for working with genomic and high throughput sequencing data.
http://fulcrumgenomics.github.io/fgbio/
MIT License
309 stars 67 forks source link

Compose a `scalafmt` configuration that applies Nils and Tim's preferred conventions #1001

Open msto opened 1 month ago

msto commented 1 month ago

fgbio PRs are expected to adhere to "tim-format," which encompasses Nils and Tim's preferred conventions for formatting Scala code.

e.g. https://github.com/fulcrumgenomics/fgbio/pull/958#discussion_r1466961356

The conventions encompassed by "tim-format" should be documented somewhere in the repository, e.g. in a CONTRIBUTING.md. Additionally, a scalafmt configuration should be composed that automatically applies these formatting conventions. (This configuration should also be adopted in Fulcrum's other Scala repos, including private client repos.)

nh13 commented 1 month ago

Thanks @msto. Given the limited time we're spending developing fgbio, this one will likely go unworked on. I am not sure it's even possible with scalfmt. But I am glad we're calling it out.