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.

Sign up for GitHub

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

Jump to bottom

[Enhancement] Add Basic Citation Meta Data #69

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

[Enhancement] Add Basic Citation Meta Data #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
924183b
[Enhancement] Add Basic Citation Meta Data
kevinmatthes Jul 25, 2022
0267fca
Revert CHANGELOG entry, see #73
kevinmatthes Jul 27, 2022
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
27 changes: 27 additions & 0 deletions .github/workflows/cffconvert.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.


on:
pull_request:
paths:
- CITATION.cff
push:
paths:
- CITATION.cff

permissions:
contents: read

jobs:
validation:
name: validate
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
with:
persist-credentials: false

- name: cffconvert
uses: citation-file-format/cffconvert-github-action@4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084
with:
args: "--validate"
23 changes: 23 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

- alias: mcobzarenco
family-names: Cobzarenco
given-names: Marius
- alias: iainh
given-names: Iain
- alias: kevinmatthes
family-names: Matthes
given-names: Kevin
- alias: KSXGitHub
- name: The Zee Community
cff-version: 1.2.0
date-released: 2022-04-23
message: Please cite this software using these meta data.
license:
- Apache-2.0
- MIT
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.

version: 0.3.2