Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add basic structure for a CITATION.cff file #93

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions {{cookiecutter.project_name}}/CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
cff-version: 1.2.0
message: "Please cite the following works when using this software."
type: software
title: {{cookiecutter.project_name}}
abstract: {{ cookiecutter.project_short_description }}
authors:
- family-names:
given-names:
orcid:
affiliation:
doi:
repository-code:
url: {{ cookiecutter.url }}
keywords:
license: {{ cookiecutter.license }}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
graft src
graft tests

include LICENSE README.md pyproject.toml setup.py setup.cfg
include LICENSE README.md pyproject.toml setup.py setup.cfg CITATION.cff
global-exclude __pycache__ *.py[cod] .*
{%- if cookiecutter.project_type == "skbuild" %}
include CMakeLists.txt
Expand Down