From ca0186c3ec5f28bd6dd2d51fcbe7e09a8a3d62a0 Mon Sep 17 00:00:00 2001 From: "E. G. Patrick Bos" Date: Fri, 6 Dec 2024 15:12:19 +0100 Subject: [PATCH] !fixup add releases --- best_practices/overview.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/best_practices/overview.md b/best_practices/overview.md index df02a21..e71b94f 100644 --- a/best_practices/overview.md +++ b/best_practices/overview.md @@ -59,8 +59,9 @@ For more information you can also [read here](https://github.com/the-turing-way/ ## Releases -Releases are a clear signal to users that your code is ready for use, rather than in active development. -It is especially useful in research for referring to from your paper for exact reproducibility. +Releases are a way to mark or point to a particular milestone in software development. +This is useful for users and collaborators, e.g. I found a bug running version x. +For publications that refer to software, refering to a specific release enhances the reproducability. See [the RSQkit task on Creating code releases](http://everse.software/RSQKit/releasing_code) for the most essential guidelines. The Turing Way offers many related tips in their [chapter on Making Research Objects Citable](https://book.the-turing-way.org/communication/citable), like how to make code citable with CITATION.CFF files.