apache / apache/cloudstack

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

オープン
#12,255 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
no-issue-activity type:enhancement
主要言語
Java
スター
3.1k
フォーク
1.4k
平均マージ
6日 19時間
マージ済み PR(30日)
32

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Issue にリンクされている GitHub citation-files のドキュメントから始め、Apache CloudStack 用のリポジトリレベルの CITATION.cff を作成します。記載されているプロジェクトタイトル、著者情報、バージョン、リリース日、Apache License 2.0 の詳細を使用します。ファイルによってソフトウェアを明確に引用できるようになれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。