Skip to content

the FAIR-IMPACT Guidelines for recommended metadata standards for research software within the EOSC presented in this document aim to provide actionable, standardized guidelines that will facilitate the adoption of existing and upcoming processes and tools in the scholarly ecosystem.

License

Notifications You must be signed in to change notification settings

FAIR-IMPACT/RSMD-guidelines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Research Software MetaData (RSMD) Guidelines

Welcome to the RSMD-guidelines repository!

Overview

RSMD is a comprehensive set of guidelines aimed at enhancing the findability, accessibility, interoperability, and reusability of research software artifacts within the European Open Science Cloud (EOSC). Developed as part of the FAIR-IMPACT project, RSMD represents the inaugural proposal of standardized metadata standards for research software.

Features

  • Standardized Metadata: RSMD offers flexible and adaptable recommendations for collecting and curating metadata attributes essential for research software, ensuring alignment with FAIR principles.
  • Community Engagement: RSMD encourages collaboration and feedback from researchers, developers, and stakeholders to refine and evolve the guidelines over time, promoting widespread adoption and adherence.
  • Integration with EOSC: RSMD aims to integrate seamlessly with existing Open Science environments and services established within the EOSC, enhancing the discoverability and usability of research software artifacts.

Getting Started

Using the RSMD guidelines in in your software

To start using RSMD in your research projects, simply:

  1. Review the RSMD Guidelines to understand the recommended metadata attributes and best practices.
  2. Checkout the RSMD checklist.
  3. Incorporate relevant metadata fields into your software documentation and repository workflows.

Implementing the guidelines in your institution

To implement the RSMD in a research institution:

  1. Fork this repository with new name, such as RSMD-guidelines@YYY.
    • for example at INRIA, use RSMD-guidelines@INRIA.
  2. Add instructions on how the recommendations is interpreted in the institution.
    • for example at INRIA, RSMD 2.1 will contain instructions on depositing in HAL.
  3. Add in the Citation section credit to the individuals in your institution contributing to the effort.

Implementing the guidelines in your infrastructure

The implementation pathway of the RSMD guidelines in a research infrastructure is yet to be defined. Let us know on #4 your thoughts on this topic.

The software metadata community

You are welcome to engage with the RSMD creators to provide feedback, contribute improvements, and share experiences.

Other relevant initiatives:

Citation

When referencing RSMD in your work, please cite the D4.4 report: Gruenpeter, M., Granger, S., Monteil, A., Chue Hong, N., Breitmoser, E., Antonioletti, M., Garijo, D., González Guardia, E., Gonzalez Beltran, A., Goble, C., Soiland-Reyes, S., Juty, N., & Mejias, G. (2024). D4.4 - Guidelines for recommended metadata standard for research software within EOSC (V1.0). Zenodo. https://doi.org/10.5281/zenodo.10786147

Contribution Guidelines

We welcome contributions from the community to enhance and expand RSMD. If you're interested in contributing, please:

  • Review the existing guidelines and documentation.
  • Submit pull requests for proposed changes, additions, or improvements.
  • Engage in discussions and provide feedback to help shape the evolution of RSMD.

Support

For questions, feedback, or assistance, please reach out to the RSMD maintainer @moranegg

License

RSMD is licensed under CC BY 4.0 (Creative Commons Attribution 4.0 International License). Please review the LICENSE file for more information.

Disclaimer

FAIR-IMPACT has received funding from the European Commission’s Horizon Europe funding programme for research and innovation programme under the Grant Agreement no. 101057344. The content of this document does not represent the opinion of the European Commission, and the European Commission is not responsible for any use that might be made of such content.


Thank you for your interest in RSMD! Together, let's advance research software recognition and curation and contribute to a more open and collaborative research ecosystem.

About

the FAIR-IMPACT Guidelines for recommended metadata standards for research software within the EOSC presented in this document aim to provide actionable, standardized guidelines that will facilitate the adoption of existing and upcoming processes and tools in the scholarly ecosystem.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published