Skip to content

Commit 4251a0e

Browse files
authored
Merge pull request #137 from OpenSemanticLab/uv-zensical-migration
docs: add citation and authorship section to CONTRIBUTING.md
2 parents 2fe14a5 + a3a8119 commit 4251a0e

2 files changed

Lines changed: 40 additions & 1 deletion

File tree

CITATION.cff

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ repository-code: "https://github.com/OpenSemanticLab/osw-python"
99
url: "https://opensemanticlab.github.io/osw-python/"
1010
doi: 10.5281/zenodo.7799493
1111
# Authors listed here are the creators shown on each Zenodo release.
12-
# Listing is opt-in: open a PR to be added.
12+
# Listing is opt-in: to be added, open a PR (see CONTRIBUTING.md,
13+
# "Citation and Authorship").
1314
authors:
1415
- family-names: Stier
1516
given-names: Simon

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,44 @@ bumps the version (in `pyproject.toml`, never edited by hand), updates the
5050
changelog, tags, builds, publishes to PyPI via trusted publishing and deploys
5151
the versioned docs. Reject the approval and nothing ships.
5252

53+
## Citation and Authorship
54+
55+
Authors of the project are listed explicitly in
56+
[`CITATION.cff`](CITATION.cff). This list is the set of creators shown on
57+
each [Zenodo](https://zenodo.org/doi/10.5281/zenodo.7799493) release. We keep
58+
it opt-in and curated rather than auto-generated from GitHub, so nobody is
59+
listed without consent, and the entries in `CITATION.cff` take precedence
60+
over GitHub's automatic contributor detection.
61+
62+
To be officially listed as an author for future Zenodo releases, add
63+
yourself to the `authors:` list in `CITATION.cff`. Two ways, in order of
64+
preference:
65+
66+
1. **Preferred, within your feature PR:** include the `CITATION.cff` edit
67+
directly in the same PR that contributes your feature or fix, so
68+
authorship is recorded together with the work.
69+
2. **Standalone PR:** if you are already a GitHub contributor and simply
70+
want to be listed as an author on Zenodo, open a single PR that only adds
71+
your entry.
72+
73+
In either case, add an entry like:
74+
75+
```yaml
76+
- given-names: Your
77+
family-names: Name
78+
affiliation: "Your institution" # optional
79+
orcid: "https://orcid.org/0000-0000-0000-0000" # optional, use your real ORCID
80+
```
81+
82+
Notes:
83+
84+
- Append yourself to the end of the list (order is the citation order);
85+
mention it in the PR if a different position is intended.
86+
- `affiliation` and `orcid` are optional but recommended for durable,
87+
unambiguous attribution.
88+
- Only entries present in `CITATION.cff` at the tagged commit appear on that
89+
release's Zenodo record, so add yourself before a release to be included.
90+
5391
## AI Guidelines
5492

5593
AI tools may be used to assist development, but a human developer is always

0 commit comments

Comments
 (0)