Skip to content

docs: add machine-readable citation metadata - #8

Merged
mkarson1997 merged 1 commit into
mainfrom
docs/citation-metadata
Sep 4, 2026
Merged

docs: add machine-readable citation metadata#8
mkarson1997 merged 1 commit into
mainfrom
docs/citation-metadata

Conversation

@mkarson1997

@mkarson1997 mkarson1997 commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Adds CITATION.cff with project identity, author, version, Apache-2.0 license, repository URL, and preferred software citation.

Closes #6

Summary by Sourcery

Documentation:

  • Add machine-readable citation metadata describing the project identity, authorship, version, license, repository, and preferred software citation.

Copilot AI lite review requested due to automatic review settings September 4, 2026 14:37

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sourcery-ai

sourcery-ai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a root-level CITATION.cff file containing standardized project metadata and preferred citation details, enabling citation tools and researchers to reference the software consistently.

File-Level Changes

Change Details Files
Add machine-readable citation metadata for the project.
  • Define project identity, author, version, and repository URL.
  • Declare the Apache-2.0 license.
  • Specify the preferred software citation.
CITATION.cff

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@mkarson1997
mkarson1997 merged commit ec2c2fa into main Sep 4, 2026
4 checks passed
@sonarqubecloud

sonarqubecloud Bot commented Sep 4, 2026

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 99653915bb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread CITATION.cff
repository-code: "https://github.com/mkarson1997/karzoun-flowforge"
url: "https://github.com/mkarson1997/karzoun-flowforge"
version: 0.1.0
date-released: 2026-09-04

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Do not advertise an unreleased version

When citation tools ingest this file, they will record version 0.1.0 as released on 2026-09-04, but this commit has no release tag and CHANGELOG.md:7 still classifies every change as Unreleased. Either omit the release-specific fields until 0.1.0 is published or update the release history as part of the release so generated citations do not claim a nonexistent release.

Useful? React with 👍 / 👎.

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.

docs: add machine-readable citation metadata

2 participants