contributing #41
contributing #41
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR refines the project’s contributor list by removing placeholder entries, injecting the dependabot[bot] account, and ensuring the SVG asset stays in sync. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
❌ Deploy Preview for shipyard failed.
|
WalkthroughUpdated Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Suggested labels
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings, 1 inconclusive)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||
1 similar comment
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Please fill out the PR description template (Category, Overview, etc.) so reviewers understand the intent of this change.
- The GitHub link for dependabot[bot] includes brackets which may break the URL; consider encoding them or using the correct username URL.
- Double-check the HTML table structure in credits.md after removing those entries to ensure rows still render correctly.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Please fill out the PR description template (Category, Overview, etc.) so reviewers understand the intent of this change.
- The GitHub link for dependabot[bot] includes brackets which may break the URL; consider encoding them or using the correct username URL.
- Double-check the HTML table structure in credits.md after removing those <td> entries to ensure rows still render correctly.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/assets/CONTRIBUTORS.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
docs/credits.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Sourcery review
🔇 Additional comments (1)
docs/credits.md (1)
1-135: Inconsistency: PR objectives describe contribution template, but changes are to credits documentation.The PR objectives state that this PR "adds a contribution template (contributing) containing a checklist and guidance for contributors." However, the file under review is
docs/credits.md, which is a credits/acknowledgments page. Additionally, the AI-generated summary mentions removing contributor entries (NxPKG/Null and gitworkflows/Null), but these removals are not visible in the provided code, which only shows the addition of the dependabot[bot] entry.Please clarify:
- Should this PR be adding a
CONTRIBUTING.mdtemplate file instead of (or in addition to) updatingdocs/credits.md?- Are there other files included in this PR that should be reviewed?
- Does the AI summary accurately reflect the actual changes made?
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/dependabot[bot]"> | ||
| <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="80;" alt="dependabot[bot]"/> | ||
| <br /> | ||
| <sub><b>dependabot[bot]</b></sub> | ||
| </a> | ||
| </td></tr> |
There was a problem hiding this comment.
🧩 Analysis chain
Verify GitHub URL format for dependabot[bot].
The GitHub profile URL uses square brackets (https://github.com/dependabot[bot]), which is non-standard. Standard GitHub URLs typically use only alphanumeric characters, hyphens, and underscores. Please verify that this URL format is correct and resolves properly to the dependabot[bot] account page. The avatar URL correctly uses the /in/ prefix for bot accounts.
Run the following command to test if the GitHub URL is valid:
🏁 Script executed:
#!/bin/bash
# Test if the GitHub URL resolves correctly
curl -s -o /dev/null -w "%{http_code}" "https://github.com/dependabot[bot]"Length of output: 0
🌐 Web query:
GitHub dependabot[bot] URL format profile page
💡 Result:
Dependabot appears as the GitHub App (not a normal user). Its public page is:
When Dependabot acts on PRs/workflows the actor/login string used is "dependabot[bot]" (e.g. github.actor == 'dependabot[bot]'), but there is no standard user-profile URL like https://github.com/dependabot[bot]. [2]
Update GitHub URL to point to the Dependabot GitHub App.
The URL https://github.com/dependabot[bot] is incorrect. Dependabot is a GitHub App with the public page at https://github.com/apps/dependabot, not a standard user profile. Update line 121 to use the correct app URL:
<a href="https://github.com/apps/dependabot">
🤖 Prompt for AI Agents
In docs/credits.md around lines 117 to 124, the anchor href incorrectly links to
a user profile URL for Dependabot; change the href on line 121 from the invalid
"https://github.com/dependabot[bot]" to the GitHub App page
"https://github.com/apps/dependabot" so the link points to the correct
Dependabot app URL while leaving the rest of the markup (img, alt, sub)
unchanged.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/credits.md (1)
117-124: GitHub URL for dependabot[bot] needs correction (previously flagged).The correct GitHub App profile URL is
https://github.com/apps/dependabot, not the user profile format with square brackets. This issue was already flagged in a previous review; please apply the suggested fix.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/credits.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Sourcery review
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/github-actions[bot]"> | ||
| <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="80;" alt="github-actions[bot]"/> | ||
| <br /> | ||
| <sub><b>github-actions[bot]</b></sub> | ||
| </a> | ||
| </td></tr> |
There was a problem hiding this comment.
GitHub URL for github-actions[bot] should point to the app page.
The correct URL for github-actions[bot] is https://github.com/apps/github-actions. The current URL with square brackets is not a valid GitHub profile URL. Apply this diff:
<td align="center">
- <a href="https://github.com/github-actions[bot]">
+ <a href="https://github.com/apps/github-actions">
<img src="https://avatars.githubusercontent.com/in/15368?v=4" width="80;" alt="github-actions[bot]"/>
<br />
<sub><b>github-actions[bot]</b></sub>
</a>
</td></tr>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <tr> | |
| <td align="center"> | |
| <a href="https://github.com/github-actions[bot]"> | |
| <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="80;" alt="github-actions[bot]"/> | |
| <br /> | |
| <sub><b>github-actions[bot]</b></sub> | |
| </a> | |
| </td></tr> | |
| <tr> | |
| <td align="center"> | |
| <a href="https://github.com/apps/github-actions"> | |
| <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="80;" alt="github-actions[bot]"/> | |
| <br /> | |
| <sub><b>github-actions[bot]</b></sub> | |
| </a> | |
| </td></tr> |
🤖 Prompt for AI Agents
In docs/credits.md around lines 125 to 132 the anchor for github-actions[bot]
uses an invalid profile URL with square brackets; update the href to the app
page URL https://github.com/apps/github-actions (replace the current
https://github.com/github-actions[bot]) so the link points to the correct GitHub
Actions app page while leaving the img, alt text and label unchanged.
2 participants
Category:
Overview
Issue Number (if applicable) #00
New Vars (if applicable)
Screenshot (if applicable)
Code Quality Checklist (Please complete)
Summary by Sourcery
Update the project’s contributor list by removing obsolete entries and adding the dependabot[bot] contributor, and reflect these changes in the CONTRIBUTORS.svg asset.
Documentation:
Summary by CodeRabbit