Add a CITATION.cff
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 20.6k
- フォーク
- 3.3k
- PR マージ指標
- PR 指標を取得中
説明
Feature
Add a CITATION.cff file to the root of the repository that contains all the necessary metadata to properly cite mypy.
Pitch
There has been a trend in some scientific communities encouraging proper citation of all tools used to conduct research. While this generally includes research methods, it may also include software tools such as mypy.
However, it can be difficult to know how to properly cite software if the information is not explicitly provided. It is helpful if the software maintainers/developers provide users with this information.
GitHub recommends, and integrates support for, CITATION.cff files. Inclusion of this file would immediately have these benefits:
- Users will have the necessary metadata to properly cite mypy.
- GitHub can automatically generate both APA and BibTeX formatted citations. A "Cite this repository" option will automatically appear on the repo's sidebar when viewed on a desktop browser.
- Reference managers like Zotero will automatically detect the metadata so the user can save the citation to their library.
Examples of popular packages using this are pandas and tensorflow.
I would be happy to create an initial version of this and open a PR if there is interest in possibly merging it after refinement.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リポジトリのルートに CITATION.cff を作成します。まず、GitHub の CITATION.cFF ガイダンス、Citation File Format のドキュメント、およびリンクされている pandas と TensorFlow の例を確認して、mypy に必要なメタデータを特定します。ファイルに完全で有効な引用メタデータが含まれ、GitHub がそこから APA と BibTeX の引用を生成できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 48/100