Skip to content

Commit ff73bc0

Browse files
committed
chore: authorship for zenodo releases through CITATION.cff file; Guideline on contributing and docs updated with how to be author on zenodo
1 parent 6446a91 commit ff73bc0

3 files changed

Lines changed: 62 additions & 0 deletions

File tree

‎CITATION.cff‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,15 @@ repository-code: "https://github.com/OO-LD/oold-python"
77
url: "https://OO-LD.github.io/oold-python/"
88
license: MIT
99
doi: 10.5281/zenodo.8374237
10+
# Authors listed here are the creators shown on each Zenodo release.
11+
# Listing is opt-in: to be added, open a PR (see CONTRIBUTING.md, "Citation and authorship").
12+
authors:
13+
- given-names: Simon
14+
family-names: Stier
15+
orcid: "https://orcid.org/0000-0003-0410-3616"
16+
- given-names: Lukas
17+
family-names: Gold
18+
orcid: "https://orcid.org/0000-0001-7444-2969"
19+
- given-names: Andreas
20+
family-names: Räder
21+
orcid: "https://orcid.org/0000-0002-2673-0832"

‎CONTRIBUTING.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,30 @@ Releases are published automatically by CI when a version tag is pushed.
8080

8181
CI will build the package (`uv build`), publish it to PyPI, and deploy the docs to GitHub Pages. The version is derived from the git tag via `hatch-vcs`, so no manual version bumping is needed.
8282

83+
## Citation and authorship
84+
85+
Authors of the project are listed explicitly in [`CITATION.cff`](CITATION.cff). This list is the set of creators shown on each [Zenodo](https://zenodo.org/doi/10.5281/zenodo.8374237) release. We keep it opt-in and curated rather than auto-generated from GitHub, so nobody is listed without consent, and the entries in `CITATION.cff` take precedence over GitHub's automatic contributor detection.
86+
87+
To be officially listed as an author for future Zenodo releases, add yourself to the `authors:` list in `CITATION.cff`. Two ways, in order of preference:
88+
89+
1. **Preferred - within your feature PR:** include the `CITATION.cff` edit directly in the same PR that contributes your feature or fix, so authorship is recorded together with the work.
90+
2. **Standalone PR:** if you are already a GitHub contributor and simply want to be listed as an author on Zenodo, open a single PR that only adds your entry.
91+
92+
In either case, add an entry like:
93+
94+
```yaml
95+
- given-names: Your
96+
family-names: Name
97+
affiliation: "Your institution" # optional
98+
orcid: "https://orcid.org/0000-0000-0000-0000" # optional, use your real ORCID
99+
```
100+
101+
Notes:
102+
103+
- Append yourself to the end of the list (order is the citation order); mention it in the PR if a different position is intended.
104+
- `affiliation` and `orcid` are optional but recommended for durable, unambiguous attribution.
105+
- Only entries present in `CITATION.cff` at the tagged commit appear on that release's Zenodo record, so add yourself before a release to be included.
106+
83107
## AI Guidelines
84108

85109
We believe that AI, and in particular LLMs, can be helpful conventional tools to accelerate development and improve quality when used responsibly. AI or any other tool is never the author of code; a human developer always is. Therefore, it is mandatory to carefully review all generated content for correctness, quality, and the absence of legal and ethical issues. For consistency, please avoid patterns that are hard to maintain manually, such as duplicated content or special characters like em dashes or UTF icons.

‎docs/contributing.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,32 @@ CI will build the package (`uv build`), publish it to PyPI, and deploy the docs
101101

102102
---
103103

104+
## Citation and authorship
105+
106+
Authors of the project are listed explicitly in `CITATION.cff`. This list is the set of creators shown on each [Zenodo](https://zenodo.org/doi/10.5281/zenodo.8374237) release. We keep it opt-in and curated rather than auto-generated from GitHub, so nobody is listed without consent, and the entries in `CITATION.cff` take precedence over GitHub's automatic contributor detection.
107+
108+
To be officially listed as an author for future Zenodo releases, add yourself to the `authors:` list in `CITATION.cff`. Two ways, in order of preference:
109+
110+
1. **Preferred - within your feature PR:** include the `CITATION.cff` edit directly in the same PR that contributes your feature or fix, so authorship is recorded together with the work.
111+
2. **Standalone PR:** if you are already a GitHub contributor and simply want to be listed as an author on Zenodo, open a single PR that only adds your entry.
112+
113+
In either case, add an entry like:
114+
115+
```yaml
116+
- given-names: Your
117+
family-names: Name
118+
affiliation: "Your institution" # optional
119+
orcid: "https://orcid.org/0000-0000-0000-0000" # optional, use your real ORCID
120+
```
121+
122+
Notes:
123+
124+
- Append yourself to the end of the list (order is the citation order); mention it in the PR if a different position is intended.
125+
- `affiliation` and `orcid` are optional but recommended for durable, unambiguous attribution.
126+
- Only entries present in `CITATION.cff` at the tagged commit appear on that release's Zenodo record, so add yourself before a release to be included.
127+
128+
---
129+
104130
## AI Guidelines
105131

106132
We believe that AI, and in particular LLMs, can be helpful conventional tools to accelerate development and improve quality when used responsibly. AI or any other tool is never the author of code; a human developer always is. Therefore, it is mandatory to carefully review all generated content for correctness, quality, and the absence of legal and ethical issues. For consistency, please avoid patterns that are hard to maintain manually, such as duplicated content or special characters like em dashes or UTF icons.

0 commit comments

Comments
 (0)