From 98c1864d5fa6c7d0eb88a9a9c9bc6cde5e91280c Mon Sep 17 00:00:00 2001 From: Gabriel Stefanini Vicente Date: Thu, 22 Feb 2024 18:26:56 -0500 Subject: [PATCH] Add CITATION.cff (#42) * Add CITATION.cff * Add alt-text --- CITATION.cff | 11 +++++++++++ README.md | 9 ++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..54fdd6c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,11 @@ +cff-version: 1.2.0 +message: "Country borders or names do not necessarily reflect the World Bank Group’s official position. All maps are for illustrative purposes and do not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries." +title: "World Bank Data Lab Project Template" +authors: + - affiliation: World Bank + family-names: Stefanini Vicente + given-names: Gabriel + orcid: https://orcid.org/0000-0001-6530-3780 +keywords: + - Open Science +repository-code: https://github.com/worldbank/template/tree/main diff --git a/README.md b/README.md index ce3f4b1..5fc6228 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Project Template +[![CalVer](https://img.shields.io/badge/calver-YY.0M.MICRO-22bfda.svg)](https://https://calver.org) +![GitHub Release](https://img.shields.io/github/v/release/worldbank/template) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/worldbank/template/main.svg)](https://results.pre-commit.ci/latest/github/worldbank/template/main) + The template is a standardized, but flexible *project* and *documentation* structure of folders and files for sharing your data science work. Inspired by [literate programming](http://literateprogramming.com), maintained by the [Development Data Group](https://www.worldbank.org/en/about/unit/unit-dec/dev) and built as [GitHub template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), the template contains: @@ -7,7 +11,10 @@ Inspired by [literate programming](http://literateprogramming.com), maintained b - [**README**](README), [**CODE_OF_CONDUCT**](docs/CODE_OF_CONDUCT.md), [**CONTRIBUTING**](docs/CONTRIBUTING.md) templates > README files are important and often neglected. The files should inform anyone about the first steps to use, learn and contribute to your project. -- **LICENSE** +- [**CITATION.cff**](CITATION.cff) + > Embracing [CFF](https://citation-file-format.github.io) aligns with best practices for reproducible research and software development. By adhering to established standards for documenting project dependencies and citations, we demonstrate our commitment to quality, transparency, and integrity in our work. + +- [**LICENSE**](LICENSE) > The LICENSE is a document that determines what others can and cannot do with contents of the repository. If no license is present, no one has permission to use and/or modify your code. The template is licensed under the [**Mozilla Public License**](https://www.mozilla.org/en-US/MPL/). And so will projects generated from it. - **docs/**