fair-software-recommendations
Plain text content of https://fair-software.eu
https://github.com/fair-software/fair-software-recommendations
Science Score: 18.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
○codemeta.json file
-
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (3.3%) to scientific vocabulary
Last synced: 10 months ago
·
JSON representation
·
Repository
Plain text content of https://fair-software.eu
Basic Info
Statistics
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 6
- Releases: 0
Created about 6 years ago
· Last pushed over 5 years ago
Metadata Files
Readme
License
Citation
README.md
Five recommendations for FAIR software
These are five recommendations that you can follow to make your software more FAIR.
- Use a publicly accessible repository with version control
- Add a License
- Register your code in a community registry
- Enable citation of the software
- Use a software quality checklist
Credit
These recommendations are hosted in the fair-software.eu website. This website is the result of a collaboration between the Netherlands eScience Center and DANS, but everybody is welcome to join the effort!
The FAIR software recommendations are licensed under a Creative Commons Attribution 4.0 International License.
Owner
- Name: fair-software
- Login: fair-software
- Kind: organization
- Repositories: 9
- Profile: https://github.com/fair-software
Citation (citation.md)
# Enable citation of the software ## Why this is important? Citation helps software developers be recognized for their work. Additionally, citation is an integral part of scientific accountability and reproducibility, but accurately citing software is inherently more difficult than citing a paper. To an outsider especially, even seemingly trivial things such as identifying who should be recognized as an author can be difficult. It is therefore convenient when software developers themselves provide the information necessary to enable citation. ## Help me choose [CodeMeta](https://codemeta.github.io/) and the [Citation File Format](https://citation-file-format.github.io/) were specifically designed to enable citation of software and will likely meet your needs. For either one, you write a plain text file with citation metadata, which you then distribute with your software. Initialize your CITATION.cff files [here](https://citation-file-format.github.io/cff-initializer-javascript/). Regarding archiving copies of your software, look for services that store their own copy of a snapshot of your software, such that whatever persistent identifier you get ([DOI, URN, ARK](https://en.wikipedia.org/wiki/Persistent_identifier), etc) points to a specific version of the software, and will continue to resolve to exactly that version for the foreseeable future. Ideally, storing snapshots of your code should be as easy as possible: either at the push of a button, or automatically, for example [each time you make a new release of your software](https://guides.github.com/activities/citable-code/). Some archiving services that meet these requirements are: - [Zenodo](https://zenodo.org/) - [FigShare](https://figshare.com/) - [Software Heritage Archive](https://softwareheritage.org/)