scieee AI-readable full text Open interactive document viewer

How to FAIRify your project in 6 steps

Heřmánková, Petra

Abstract

Six-step workflow on how to publish your digital project in accordance with the principles of FAIR and Open Science.

Full text

How to FAIRify your project in 6 steps bit.ly/FAIRify Author: Petra Heřmánková @petrifiedvoices, https://orcid.org/0000-0002-6349-0540 License: CC-BY-SA-4.0 Credit: inspired by https://guides.lib.berkeley.edu/citeyourcode If you don’t have a GitHub repository, you can upload the data directly to Zenodo (once you register). 1. Have a repository on GitHub with your code/data, including the following docs: a. Make the repo public b. README.md - why have a Readme file? c. LICENSE.md - licensing d. CITATION.cff - how to create one and why 2. Create an account/Login to Zenodo, using your GitHub account (or alternatively ORCID) a. You may need to authorise the Zenodo application. Zenodo will redirect you back to GitHub for Authorization 3. Back in Zenodo, find your GitHub repository: a. From the drop-down menu next to your email address at the top of the page, select GitHub. b. You will be presented with a list of all your GitHub repositories c. Select a repository you want to archive on Zenodo. d. Toggle the "on" button next to the repository you want to archive. e. Click on the Repo that you want to archive. f. Click on the ‘Create release’ button. Zenodo will redirect you back to GitHub’s repo page to generate a release 4. Back on GitHub, create a release. Zenodo will automatically download a .zip-tarball of each new release and register a unique DOI. a. If this is the first release of your code, then you should give it a version number of v1.0.0. or similar. Follow the instructions provided by GitHub. Add a description for your release, then click the Publish release button. b. You can make a pre-release if this is not the final stage. 5. Edit the archive’s metadata on Zenodo and/or publish a new version of your software (go to Uploads on Zenodo/Edit) a. Note that the data from the CFF file should already be filled in. 6. Your code is now published on a GitHub public repository and archived on Zenodo with a unique DOI. a. Zenodo takes an archive of your GitHub repository each time you create a new Release and issues a new DOI for each version. All versions are linked. b. You can also upload your citation file to Zotero and claim the fame and glory of your first FAIR digital publication. c. Additionally, you can add your publication to one of the many Zenodo communities. If it is approved, your publication will be findable together with other records within that community. DOI: https://doi.org/10.5281/zenodo.17838576 v1.0.0, published 20251206 Caveats: Once you publish your project on Zenodo, it takes a lot of work to delete it. Use the Sandbox for experiments. Further reading: PARTHENOS, Hella Hollander, Francesca Morselli, et al. PARTHENOS Guidelines to FAIRify Data Management and Make Data Reusable. Zenodo, 1 December 2018. https://doi.org/10.5281/zenodo.2668479. Creamer, Andrew, Gaia Lembi, Elli Mylonas, and Michael Satlow. ‘Archiving a TEI Project FAIRly’. Journal of the Text Encoding Initiative, no. Issue 14 (March 2021). https://doi.org/10.4000/jtei.4324. DOI: https://doi.org/10.5281/zenodo.17838576 v1.0.0, published 20251206