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

[Enhancement] Add Basic Citation Meta Data #69

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kevinmatthes
Copy link
Contributor

This Pull Request brings an initial CFF as suggested in #61.

Copy link
Contributor Author

@kevinmatthes kevinmatthes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some explanations to the changed files. If you should notice wrong entries, please tell me such that I can fix them.

@@ -0,0 +1,27 @@
name: cffconvert
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whenever the citation meta data are edited, this workflow ensure them to be correct.

CHANGELOG.md Outdated Show resolved Hide resolved
@@ -0,0 +1,23 @@
abstract: A modern text editor for the terminal written in Rust.
authors:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file controls which BibTeX entry will be rendered by GitHub such that one can cite Zee in papers and theses. I initially added all contributors listed on the project's starting page by their configured public GitHub account data in the current order of appearance. "The Zee Community" refers to all the people who suggested features and outlined bugs but did not recently contribute to this repository. I would like to suggest that, just as with the CHANGELOG, people who contribute the first time also add their names in the file if they would like to.

@mcobzarenco, @iainh, @KSXGitHub, please tell me whether and, if so, how your entries should be adjusted. I tried to deduce the required meta data from your accounts but I did not always succeed doing so. If you do not want to cited for any reason, please inform me as well such that I can remove the entry.

repository-artifact: https://crates.io/crates/zee
repository-code: https://github.com/zee-editor/zee
title: zee
url: https://github.com/zee-editor/zee
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This field controls which URL is rendered in the BibTeX entry. I initially set it to this repository but changing is no problem.

@kevinmatthes
Copy link
Contributor Author

There is also the possibility to add a badge to the README that the CFF data are valid. Shall I add it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant