Conversation
|
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! |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
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! |
PR Summary
|
|
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! |
There was a problem hiding this comment.
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 repositoryis 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 = ``;
- 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>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 = ``; | ||
| 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`; |
There was a problem hiding this comment.
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.
| 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`; |
Summary by Sourcery
Enhancements: