Releases: Imageomics/Collaborative-distributed-science-guide
Release list
v2.0.0
This release introduces the "Quick References" tab to house the "Command Line Cheat Sheet" and a new guide to PyPI & Zenodo Release Automation. Other big changes include improved research data storage guidelines; an overhaul of the Hugging Face dataset upload guide to better reflect the preferred methods; revising the citation section of the GitHub Repo Guide for improved clarity, including the addition of citation CFF templates; and further clarification in the PR Review response section of the GitHub PR guide, including updates based on recent GitHub UI changes.
What's Changed
- Add release commit hash by @egrace479 in #63
- Makes storage location guidelines for research data more general by @hlapp in #66
- HF upload guide update by @egrace479 in #65
- Fix typo in DataFrame initialization by @egrace479 in #70
- Revise Citation section of GH repo guide by @egrace479 in #69
- Clarify the button to press on UI to get to PR files by @egrace479 in #75
- Patch for Incorporating PR Feedback by @egrace479 in #74
- Add admonition to emphasize keeping tokens private and scoped by @egrace479 in #72
- Add quick reference page for auto release to pypi and zenodo by @egrace479 in #76
- Add tip to look at rendering on branch to check citation file by @egrace479 in #77
- Update actions and Node versions by @egrace479 in #78
- Add image showing citation cff check on GitHub by @egrace479 in #79
- Add appropriate alt-text to the collaborative infrastructure diagram by @egrace479 in #80
- Update citation file for new major release by @egrace479 in #81
New Contributors
Full Changelog: v1.4.0...v2.0.0
v1.4.0
The Collaborative Distributed Science Guide now has its own, easily generalized, color scheme! Other big changes include updates to the Repo guides for both GitHub and Hugging Face and an automated linting workflow for PRs.
What's Changed
- Add commit hash of release by @egrace479 in #41
- feat: Set up markdownlint GitHub Action for automated linting (Closes #14) by @EmersonFras in #42
- Add special thanks section for non-author contributions by @egrace479 in #48
- Add links to repos with good READMEs as examples for repo types by @egrace479 in #50
- Add statement regarding Google Drive by @egrace479 in #49
- bug: Markdownlint Action Ignore Templates by @EmersonFras in #53
- Clarify license and citation guidance for Hugging Face by @egrace479 in #51
- fix: replace incorrect "eg." with "e.g." throughout project by @gwtaylor in #55
- docs(tools): add Vale prose linter section by @gwtaylor in #23
- Implement new color scheme by @egrace479 in #60
- Increment minor version for new release by @egrace479 in #62
New Contributors
- @EmersonFras made their first contribution in #42
- @gwtaylor made their first contribution in #55
Full Changelog: v1.3.0...v1.4.0
v1.3.0
What's Changed
- Add commit hash of release by @egrace479 in #34
- Add cherry-pick guide for fetching new material from upstream by @egrace479 in #35
- Clarify remote options note by @egrace479 in #36
- Update to preferred name by @egrace479 in #38
- Add ref & link to Gundersen paper, not just presentation by @egrace479 in #37
- pre-release update of version and publication date by @egrace479 in #40
Full Changelog: v1.2.1...v1.3.0
v1.2.1
What's Changed
- Post-release update by @egrace479 in #31
- Fix broken links by @egrace479 in #32
- pre-release update by @egrace479 in #33
Full Changelog: v1.2.0...v1.2.1
v1.2.0
What's Changed
- Add new release commit hash by @egrace479 in #22
- Add version-agnostic DOI to citation file by @egrace479 in #25
- Add SSHRC to the footer acknowledgement by @egrace479 in #26
- Promote citation file to standard and add DOI note by @egrace479 in #24
- Update GitHub Repo Archiving Guidance by @egrace479 in #29
- Pre-release updates to version and date by @egrace479 in #30
Full Changelog: v1.1.0...v1.2.0
v1.1.0
What's Changed
- post-release update by @egrace479 in #13
- Re-organize and add more helpful tools by @egrace479 in #19
- Redirect CVAT Guide link now KABR tools site is up by @egrace479 in #20
- Add API accessible description key to HF templates by @egrace479 in #18
- New release citation updates by @egrace479 in #21
Full Changelog: v1.0.2...v1.1.0
v1.0.2
This patch version is a fix to the Zenodo metadata integration file (see #11). There are no substantive changes.
What's Changed
- post-release update by @egrace479 in #10
- Fix Zenodo metadata integration issue by @egrace479 in #11
- Pre-release update (version + date) by @egrace479 in #12
Full Changelog: v1.0.1...v1.0.2
v1.0.1
What's Changed
- Add release commit info by @egrace479 in #1
- Set more scoped permissions for GH token by @egrace479 in #6
- Ref #3: add AI use policy by @egrace479 in #7
- Pre-release update by @egrace479 in #8
- Set python to newest version to avoid deprecation by @egrace479 in #9
New Contributors
- @egrace479 made their first contribution in #1
Full Changelog: v1.0.0...v1.0.1
v1.0.0
Introducing the Collaborative Distributed Science Guide!
This website is a guide to collaborative work, including GitHub and Hugging Face workflows, which was co-developed with the Imageomics Guide. It is made available in this more general format for those interested in general guidelines. In particular, this repository is provided as a template for others to contribute their knowledge and experience to improve the guide or to create a version of this guide for their own organization or group.