Archive Code
Like data and other materials, you can create an archived copy of your code using the OSF even if your GitHub repositories continue development. There are several steps to effectively archive and share your code on the OSF.
- Create an OSF Project
- An OSF Project is a flexible space where you can prepare the details of your research activity and contributors.
Use this guide to quickly create your own OSF Project.
- Link your GitHub repo to your OSF Project
- OSF Add-ons are integrations that enable you to represent your code, data, citations, and more from other tools and platforms directly through your OSF Project. All files and content will render in the OSF, and your Project collaborators can update this content if you have given them permissions to do so.
Use this guide to authenticate your GitHub account and choose the code repo that you would like to archive.
- Archive your OSF Project using an OSF Registration
- You can make an archived snapshot of your OSF Project with an OSF Registration.
- All of your files, including those that are associated with the Project through add-ons, will be copied and archived.
- All OSF Registrations get a Digital Object Identifier (DOI) for easy and responsible sharing, and you can associated enhanced metadata like funders and DOIs of your related materials like papers and data. You can label your Registration with the appropriate resource type for increased discoverability, like "software", "workflow", or "interactive resource".
Use this guide to make an archived version of your OSF Project using the Open-Ended Registration template.
- Share your code and other work
- All public objects on OSF are indexed across the web, and more comprehensive metadata increase the discoverability, use, and citation.
- Use this guide to learn more about the persistent identifiers (PIDs) available on OSF for the most effective research describing and sharing.
This Article Is Licensed Under CCO For Maximum Reuse.