euroargodev / euroargodev/software_guidelines
The project clearly list all software identifiers in the README file (e.g. DOI, SWHID)
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Description
Including software identifiers (see guideline #49 ) in the README serves as a centralized reference point for anyone interacting with the project, ensuring that critical metadata is immediately visible and accessible.
By doing so, users, contributors, and researchers can easily find, cite, and reference the software in their work. This practice enhances discoverability, reproducibility, and proper attribution, aligning with FAIR4RS principles.
To provide all relevant unique IDs in the README file of your repository, it is quite usual to insert *badges* at the top of the file, see examples below.
### Examples
This markdown code for a DOI:
```markdown
[![DOI][joss-badge]][joss-link]
[joss-badge]: https://img.shields.io/badge/DOI-10.21105%2Fjoss.02425-brightgreen
[joss-link]: https://dx.doi.org/10.21105/joss.02425
```
will render as:
[![DOI][joss-badge]][joss-link]
[joss-badge]: https://img.shields.io/badge/DOI-10.21105%2Fjoss.02425-brightgreen
[joss-link]: https://dx.doi.org/10.21105/joss.02425
This markdown code for a SWHID:
```markdown

```
will render as:

Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.