From 6446a919ed7700ad107bb1d99d0b8b78561026f1 Mon Sep 17 00:00:00 2001 From: Andreas Raeder Date: Fri, 3 Jul 2026 16:44:33 +0200 Subject: [PATCH 1/2] docs: rm authors entirely to make use of auto contributor fetching from github (bots should be already ignored) --- AUTHORS.md | 3 --- CITATION.cff | 3 --- README.md | 13 ------------- 3 files changed, 19 deletions(-) delete mode 100644 AUTHORS.md diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index 73405a5..0000000 --- a/AUTHORS.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributors - -* SimonStier [simon.stier@isc.fraunhofer.de](mailto:simon.stier@isc.fraunhofer.de) diff --git a/CITATION.cff b/CITATION.cff index 6442be6..a8b21b6 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -7,6 +7,3 @@ repository-code: "https://github.com/OO-LD/oold-python" url: "https://OO-LD.github.io/oold-python/" license: MIT doi: 10.5281/zenodo.8374237 -authors: - - name: "OO-LD Contributors" - website: "https://github.com/OO-LD/oold-python/graphs/contributors" diff --git a/README.md b/README.md index eadc7f1..91b2c0f 100644 --- a/README.md +++ b/README.md @@ -274,16 +274,3 @@ pre-commit install ``` Please also enable GitHub Actions on your fork so the test suite runs automatically. - -## Citation - -If you use oold-python in your research, please cite it: - -```bibtex -@software{oold_python, - author = {OO-LD Contributors}, - title = {oold-python: Object Oriented Linked Data for Python}, - url = {https://github.com/OO-LD/oold-python}, - doi = {10.5281/zenodo.8374237}, -} -``` From ff73bc063afcabd27aa3b564ddcce08d96640b5d Mon Sep 17 00:00:00 2001 From: Andreas Raeder Date: Sun, 19 Jul 2026 12:27:30 +0200 Subject: [PATCH 2/2] chore: authorship for zenodo releases through CITATION.cff file; Guideline on contributing and docs updated with how to be author on zenodo --- CITATION.cff | 12 ++++++++++++ CONTRIBUTING.md | 24 ++++++++++++++++++++++++ docs/contributing.md | 26 ++++++++++++++++++++++++++ 3 files changed, 62 insertions(+) diff --git a/CITATION.cff b/CITATION.cff index a8b21b6..79d83f7 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -7,3 +7,15 @@ repository-code: "https://github.com/OO-LD/oold-python" url: "https://OO-LD.github.io/oold-python/" license: MIT doi: 10.5281/zenodo.8374237 +# Authors listed here are the creators shown on each Zenodo release. +# Listing is opt-in: to be added, open a PR (see CONTRIBUTING.md, "Citation and authorship"). +authors: + - given-names: Simon + family-names: Stier + orcid: "https://orcid.org/0000-0003-0410-3616" + - given-names: Lukas + family-names: Gold + orcid: "https://orcid.org/0000-0001-7444-2969" + - given-names: Andreas + family-names: Räder + orcid: "https://orcid.org/0000-0002-2673-0832" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0de23f..b488341 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,6 +80,30 @@ Releases are published automatically by CI when a version tag is pushed. 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. +## Citation and authorship + +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. + +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: + +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. +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. + +In either case, add an entry like: + +```yaml + - given-names: Your + family-names: Name + affiliation: "Your institution" # optional + orcid: "https://orcid.org/0000-0000-0000-0000" # optional, use your real ORCID +``` + +Notes: + +- Append yourself to the end of the list (order is the citation order); mention it in the PR if a different position is intended. +- `affiliation` and `orcid` are optional but recommended for durable, unambiguous attribution. +- 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. + ## AI Guidelines 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. diff --git a/docs/contributing.md b/docs/contributing.md index e6906e2..e563bd6 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -101,6 +101,32 @@ CI will build the package (`uv build`), publish it to PyPI, and deploy the docs --- +## Citation and authorship + +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. + +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: + +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. +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. + +In either case, add an entry like: + +```yaml + - given-names: Your + family-names: Name + affiliation: "Your institution" # optional + orcid: "https://orcid.org/0000-0000-0000-0000" # optional, use your real ORCID +``` + +Notes: + +- Append yourself to the end of the list (order is the citation order); mention it in the PR if a different position is intended. +- `affiliation` and `orcid` are optional but recommended for durable, unambiguous attribution. +- 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. + +--- + ## AI Guidelines 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.