snakemake / snakefmt

The uncompromising Snakemake code formatter
MIT License
151 stars 29 forks source link

Add CITATION file #195

Closed mbhall88 closed 1 year ago

mbhall88 commented 1 year ago

Addresses #194

codecov[bot] commented 1 year ago

Codecov Report

Merging #195 (1615e16) into master (05ae61d) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #195   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files          12       12           
  Lines        1014     1014           
  Branches      222      222           
=======================================
  Hits          995      995           
  Misses         10       10           
  Partials        9        9           
Flag Coverage Δ
unittests 98.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

bricoletc commented 1 year ago

V. nice I have two questions:

i) do we leave the citation part in README.md? I would vote yes ii) We used to credit ppl in our CHANGELOG.md (thanks @schackartk this is a nice addition), can we still do this with our release please system? Can we manually add an entry to CHANGELOG without that messing up its own system?

mbhall88 commented 1 year ago

i) do we leave the citation part in README.md? I would vote yes

Agreed

ii) We used to credit ppl in our CHANGELOG.md (thanks @schackartk this is a nice addition), can we still do this with our release please system? Can we manually add an entry to CHANGELOG without that messing up its own system?

We can manually edit the CHANGELOG after a release. That shouldn't stuff it up I think. Though I don't know much about release-please so maybe @johanneskoester can shed some light?