apache / apache/cloudstack

We can add a CITATION file to the repository to help users correctly cite the CloudStack software.

Ouverte
#12,255 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
no-issue-activity type:enhancement
Langage dominant
Java
Étoiles
3.1k
Forks
1.4k
Merge moyen
6 j 19 h
PR mergées (30 j)
32

Description

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Yes, a GitHub citation file, specifically a **`CITATION.cff`** file using the Citation File Format (CFF), would be **appropriate and beneficial** for Apache CloudStack to use in its GitHub repository.

### 🎯 Why a `CITATION.cff` File is Suitable

1. **Open Source Best Practice:** Adding a `CITATION.cff` file is widely considered a best practice for open-source software, especially for projects that might be referenced in academic, industry, or research papers. GitHub actively supports this format.
2. **Ease of Citation:** The file makes it extremely easy for users to correctly cite the software. GitHub automatically detects the `CITATION.cff` file and displays a "Cite this repository" link on the repository page, which provides pre-formatted citations in styles like APA and BibTeX.
3. **Recognition for Contributors:** Proper citation ensures that the project and its contributors receive appropriate academic and professional credit when their work is used or built upon. This is a key principle of open-source and research work.
4. **Machine- and Human-Readable:** The format is simple YAML, which is easy for humans to read and machines (like citation generators) to parse, ensuring accuracy across various platforms and tools.
5. **Alignment with Apache's Status:** Apache CloudStack is a Top-Level Project (TLP) of the Apache Software Foundation and is a mature, widely used IaaS platform. Providing a clear citation method reinforces its status as a foundational piece of technology that warrants formal reference.

### 📝 Key Details for CloudStack's Citation

If Apache CloudStack were to implement this, the `CITATION.cff` file would likely specify:

* **Type:** `software` or `software-code`.
* **Title:** "Apache CloudStack" (or similar).
* **Authors:** The collective organization (Apache Software Foundation, on behalf of the project contributors).
* **Version:** The current major/minor version (e.g., `4.21.0.0`).
* **Date Released:** The date of the corresponding release.
* **License:** The Apache License Version 2.0.

It is a common practice for large projects like Apache CloudStack to leverage features like the `CITATION.cff` file to ensure their work is properly credited.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la documentation GitHub citation-files liée dans l’issue, puis créez un CITATION.cff au niveau du dépôt pour Apache CloudStack. Utilisez le titre du projet, les informations d’auteur, la version, la date de publication et les détails d’Apache License 2.0 indiqués ; le travail est terminé lorsque le fichier fournit une citation claire du logiciel.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.