Skip to content

Commit

Permalink
!fixup add releases
Browse files Browse the repository at this point in the history
  • Loading branch information
egpbos committed Dec 6, 2024
1 parent f9411a1 commit ca0186c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions best_practices/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit ca0186c

Please sign in to comment.