Skip to content

Adding LICENSE and CITATION.cff, prep for zenodo workflow - #96

Open
mattleblanc wants to merge 2 commits into
mainfrom
license
Open

Adding LICENSE and CITATION.cff, prep for zenodo workflow#96
mattleblanc wants to merge 2 commits into
mainfrom
license

Conversation

@mattleblanc

Copy link
Copy Markdown
Collaborator

This PR adds a LICENSE (Apache-2.0) and CITATION.cff (including all contributors, alphabetically ordered).

This is prep for a workflow that will automatically mint Zenodo records for our software releases, making it easier to cite this software stack.

Copilot AI lite review requested due to automatic review settings September 3, 2026 14:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The changes are additive, correctly formatted metadata/licensing files with no functional code impact and no issues found in the added content.

Pull request overview

This PR prepares the repository for easier software citation and automated Zenodo deposition by adding standard licensing and citation metadata files.

Changes:

  • Added an Apache License 2.0 LICENSE file with project copyright notice.
  • Added CITATION.cff with CFF 1.2.0 metadata (title, repository URL, license, authors + ORCIDs).
  • Added .zenodo.json with Zenodo/GitHub integration metadata (title/description/license/keywords/creators).
File summaries
File Description
LICENSE Adds Apache-2.0 license text and project copyright notice.
CITATION.cff Adds CFF citation metadata for GitHub’s citation UI and downstream tooling.
.zenodo.json Adds Zenodo metadata to support automated record creation on releases.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@madbaron

madbaron commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Noting this down here too for book-keeping.
We should design a way to auto-update the CITATION.cff once a new contributor lands a commit on the repo.

Perhaps there's a dependabot-like service that we can schedule to run once per week and open a PR with new authors when needed, though the jump from github username to orcid may not be always trivial.

@mattleblanc

Copy link
Copy Markdown
Collaborator Author

@madbaron agreed. I can do that in a future PR, I think.

@madbaron

madbaron commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Looks good to me, thanks!

I'd leave it here for a little longer, especially to make sure @pandreetto @kkrizka @gianelle @bartosik-hep have a chance to react.

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.

3 participants