AlphaGenes / AlphaPeel

AlphaPeel: calling, phasing, and imputing genotype and sequence data in pedigrees
MIT License
2 stars 11 forks source link

Add NEWS/Changelog file to summarise key changes between versions #87

Open gregorgorjanc opened 1 year ago

gregorgorjanc commented 1 year ago

We should add a NEWS/Changelog file to summarise key changes between versions and each PR addressing an issue should add a line or two so we grow this file “organically” and then have it ready for new version release.

@XingerTang and @AprilYUZhang what is the Python way of doing this?

AprilYUZhang commented 1 year ago

maybe slap can help us, but I haven't use it.

XingerTang commented 1 year ago

@gregorgorjanc I haven't used Python-specific changelog files before. Maybe we can add a rst file for it, this is how the read the docs write their change logs, so it can be easily integrated into the documentation.

gregorgorjanc commented 1 year ago

RST or MD would work just well https://github.com/tskit-dev/msprime/blob/main/CHANGELOG.md

XingerTang commented 1 year ago

https://github.com/vweevers/common-changelog#12-guiding-principles gives a style guide for changelogs, and https://alphaos.app/blog/github-changelog-tools gives some Github changelog generators