Skip to content

Commit

Permalink
chore(release): update CHANGELOG and CITATION ahead of first release
Browse files Browse the repository at this point in the history
  • Loading branch information
amyheather committed Jul 4, 2024
1 parent 8b419e7 commit 40563fa
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 61 deletions.
66 changes: 6 additions & 60 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,70 +5,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Dates formatted as YYYY-MM-DD as per [ISO standard](https://www.iso.org/iso-8601-date-and-time-format.html).

<!-- TODO: Delete the CHANGELOG entries for the reproduction template, but use their structure to create entries for your project, i.e.
## v0.1.0 - 2024-07-04

## v0.1.0
**Release date:** [Date]
**Contributors:** [Researcher name]
[One-sentence summary of release]
First release with defined scope for reproduction.

### Added

*
* Code from original study
* Article
* Planned scope for reproduction

### Changed

*
### Removed
*
### Fixed
*
-->

## v1.0.2

**Release date:** 3rd July 2024

**Contributors:** Amy Heather

Minor improvements following the first reproducibility assessment ([Shoaib and Ramamohan 2022](https://github.com/pythonhealthdatascience/stars-reproduce-shoaib-2022)).

### Added

* Template page (`reflections.qmd`) for reflections on facilitators and barriers to reproduction, and for full list of troubleshooting steps

### Changed

* Add `.vscode/` to `.gitignore`
* Add citation to protocol on quarto site home page
* Order of criteria in `badges.qmd` (so it is a consistent order between the dictionary of criteria names and results, making it easier when conducting the assessment to look between the two)
* Amended `TODO:` comments in CHANGELOG and GHCR GitHub action
* Add missing `<!--- -->` marker in `artefacts.qmd`
* Improved the "succesfully reproduced" template sentence in `reproduction_report.qmd`

## v1.0.1

**Release date:** 19th June 2024

**Contributors:** Amy Heather

Fix to citation file to prevent error on Zenodo.

### Fixed

* Completed `CITATION.cff` to reflect this repository (rather than to be a blank example), to prevent error when syncing with Zenodo

## v1.0.0

**Release date:** 19th June 2024

**Contributors:** Amy Heather, with review of the protocol and associated artefacts (such as this template) from Tom Monks, Alison Harper and Nav Mustafee

Initial release of template repository. 🌱
* Modified template to be relevant to Huang et al. 2019
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ abstract: >-
license: GPL-3.0
# TODO: Manually update with each GitHub release (start with 0.1.0)
version: '0.1.0'
date-released: '2024-06-19'
date-released: '2024-07-04'

0 comments on commit 40563fa

Please sign in to comment.