Skip to content

refactor: ♻️ Update to github issue text#174

Merged
slugb0t merged 1 commit into
mainfrom
staging
Dec 11, 2025
Merged

refactor: ♻️ Update to github issue text#174
slugb0t merged 1 commit into
mainfrom
staging

Conversation

@slugb0t
Copy link
Copy Markdown
Member

@slugb0t slugb0t commented Dec 11, 2025

Summary by Sourcery

Enhancements:

  • Update archival, license, and metadata templates to separate license requirement messaging and introduce explicit warnings about checks running only after a LICENSE file is detected.

@fairdataihub-bot
Copy link
Copy Markdown

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Dec 11, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates GitHub issue template text for archival, license, and metadata compliance checks to clarify that certain checks only run after a LICENSE file is detected, using more concise wording and GitHub-style warning callouts.

File-Level Changes

Change Details Files
Refine archival compliance no-license message to indicate deferred checking until a LICENSE exists.
  • Update explanatory text about FAIR archiving requirements when no license is present
  • Replace long guidance with a concise statement and a GitHub-style WARNING callout about checks running only after a LICENSE is detected
bot/compliance-checks/archival/index.js
Simplify license compliance failure messaging while keeping action guidance.
  • Shorten the description of why a LICENSE file is required for reusability
  • Remove mention that metadata and FAIR release status will not be checked until a LICENSE is added
  • Retain and slightly reflow instructions for using Codefair to add a license or adding one manually
bot/compliance-checks/license/index.js
Clarify metadata compliance messaging when license is missing and add explicit warning callout.
  • Keep description of required metadata files for FAIR software
  • Add GitHub-style WARNING callout explaining the check will run after a LICENSE file is detected
  • Remove inline sentence about dependency on LICENSE in favor of the callout
bot/compliance-checks/metadata/index.js

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

@fairdataihub-bot
Copy link
Copy Markdown

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!

@what-the-diff
Copy link
Copy Markdown

what-the-diff Bot commented Dec 11, 2025

PR Summary

  • Enhanced Warning on Missing License File
    The error message that comes up when the license file is missing has been improved in index.js file. The updated message also notifies that the system will keep checking until the LICENSE file is found in the project directory, hence improving the software’s compliance checks.

  • Clarified Message about Absence of License
    The warning regarding the absence of a LICENSE has been revised to make it more clear in index.js. This change helps everybody understand the importance of having a LICENSE in the project without changing the original message's context.

  • Upgraded Metadata Check Alert
    The alert generated by the metadata check system has been updated in index.js for better clarity. Now it includes information about its dependency on the LICENSE file, creating better transparency about how the system works and the importance of having a LICENSE file.

@slugb0t slugb0t merged commit 288b399 into main Dec 11, 2025
4 of 5 checks passed
@fairdataihub-bot
Copy link
Copy Markdown

Thanks for closing this pull request! If you have any further questions, please feel free to open a new issue. We are always happy to help!

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • The new warning text Codefair will run this check after a LICENSE file is detected in your repository is a bit vague in the archival template; consider explicitly naming the check (e.g., Codefair will run the FAIR release check...) to avoid ambiguity for users.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new warning text `Codefair will run this check after a LICENSE file is detected in your repository` is a bit vague in the archival template; consider explicitly naming the check (e.g., `Codefair will run the FAIR release check...`) to avoid ambiguity for users.

## Individual Comments

### Comment 1
<location> `bot/compliance-checks/metadata/index.js:1315` </location>
<code_context>
       // License was not found
       const metadataBadge = `![Metadata](https://img.shields.io/badge/Metadata_Not_Checked-fbbf24)`;
-      baseTemplate += `## Metadata\n\nTo make your software FAIR a \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository. A LICENSE file is dependent for these files to be checked and validated.Codefair will check for these files after a license file is detected.\n\n${metadataBadge}\n\n`;
+      baseTemplate += `## Metadata\n\nTo make your software FAIR a \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository.\n> [!WARNING]\n> Codefair will run this check after a LICENSE file is detected in your repository.\n\n${metadataBadge}\n\n`;
     }

</code_context>

<issue_to_address>
**suggestion (typo):** Tighten the grammar around the description of required metadata files.

The phrase `a \\`CITATION.cff\\` and \\`codemeta.json\\` metadata files are expected` is grammatically inconsistent (singular `a` with plural `files`). Consider `the \\`CITATION.cff\\` and \\`codemeta.json\\` metadata files are expected` or `a \\`CITATION.cff\\` file and a \\`codemeta.json\\` file are expected` instead.

```suggestion
      baseTemplate += `## Metadata\n\nTo make your software FAIR the \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository.\n> [!WARNING]\n> Codefair will run this check after a LICENSE file is detected in your repository.\n\n${metadataBadge}\n\n`;
```
</issue_to_address>

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.

// License was not found
const metadataBadge = `![Metadata](https://img.shields.io/badge/Metadata_Not_Checked-fbbf24)`;
baseTemplate += `## Metadata\n\nTo make your software FAIR a \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository. A LICENSE file is dependent for these files to be checked and validated.Codefair will check for these files after a license file is detected.\n\n${metadataBadge}\n\n`;
baseTemplate += `## Metadata\n\nTo make your software FAIR a \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository.\n> [!WARNING]\n> Codefair will run this check after a LICENSE file is detected in your repository.\n\n${metadataBadge}\n\n`;
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

suggestion (typo): Tighten the grammar around the description of required metadata files.

The phrase a \\CITATION.cff\ and \\codemeta.json\ metadata files are expected is grammatically inconsistent (singular a with plural files). Consider the \\CITATION.cff\ and \\codemeta.json\ metadata files are expected or a \\CITATION.cff\ file and a \\codemeta.json\ file are expected instead.

Suggested change
baseTemplate += `## Metadata\n\nTo make your software FAIR a \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository.\n> [!WARNING]\n> Codefair will run this check after a LICENSE file is detected in your repository.\n\n${metadataBadge}\n\n`;
baseTemplate += `## Metadata\n\nTo make your software FAIR the \`CITATION.cff\` and \`codemeta.json\` metadata files are expected at the root level of your repository.\n> [!WARNING]\n> Codefair will run this check after a LICENSE file is detected in your repository.\n\n${metadataBadge}\n\n`;

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.

1 participant