Conversation
📝 WalkthroughWalkthroughThe changes restructure the CONTRIBUTING.md documentation, update the UI configuration to separate issue creation and pull request guidance, and modify the contribution template to display multiple navigation options including a new issue creation path. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Line 21: The <img> tag for contribution_cta.png in the CONTRIBUTING.md lacks
an alt attribute; update the <img> element to include a concise, descriptive alt
text (e.g., "Call to contribute illustration" or similar) so screen readers and
markdownlint (MD045) are satisfied—locate the <img
src="./assets/images/contribution_cta.png" width="400"> and add an appropriate
alt="..." attribute.
In `@data/ui.yml`:
- Around line 61-67: The contribution_cta block is missing the to_issues key
referenced by the template (ui.contribution_cta.to_issues), which causes
rendering errors; update the contribution_cta mapping in data/ui.yml by adding a
to_issues entry (similar to to_new_issue) with the appropriate label/URL text so
includes/contribution.html can read ui.contribution_cta.to_issues; ensure the
new key name is exactly to_issues and placed alongside title, body,
to_new_issue, to_guidelines, or, and button.
In `@includes/contribution.html`:
- Around line 14-15: Remove the duplicate CTA paragraph and fix the concatenated
anchors: keep a single paragraph using the template tokens {% data
ui.contribution_cta.or %}, {% data ui.contribution_cta.to_guidelines %} and {%
data ui.contribution_cta.to_new_issue %} (not {% data
ui.contribution_cta.to_issues %} twice), and insert a visible separator (e.g., a
space and the word "or" via {% data ui.contribution_cta.or %} or a middot)
between the two <a> tags so the guidelines link ({% data
ui.contribution_cta.to_guidelines %}) and the new-issue link ({% data
ui.contribution_cta.to_new_issue %}) are not concatenated; remove the extra
paragraph that duplicates the CTA.
| ### Use the 'make a contribution' button | ||
|
|
||
| If you spot something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. | ||
| <img src="./assets/images/contribution_cta.png" width="400"> |
There was a problem hiding this comment.
Add alt text to the image for accessibility.
The image is missing alternate text, which is required for accessibility (screen readers) and is flagged by markdownlint (MD045).
🔧 Proposed fix
-<img src="./assets/images/contribution_cta.png" width="400">
+<img src="./assets/images/contribution_cta.png" width="400" alt="Screenshot of the 'Make a contribution' button on a GitHub Docs article">📝 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.
| <img src="./assets/images/contribution_cta.png" width="400"> | |
| <img src="./assets/images/contribution_cta.png" width="400" alt="Screenshot of the 'Make a contribution' button on a GitHub Docs article"> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
21-21: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 21, The <img> tag for contribution_cta.png in the
CONTRIBUTING.md lacks an alt attribute; update the <img> element to include a
concise, descriptive alt text (e.g., "Call to contribute illustration" or
similar) so screen readers and markdownlint (MD045) are satisfied—locate the
<img src="./assets/images/contribution_cta.png" width="400"> and add an
appropriate alt="..." attribute.
| contribution_cta: | ||
| title: Help us make these docs great! | ||
| body: All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request. | ||
| button: Make a contribution | ||
| body: All GitHub docs are open source. See something that's wrong or unclear? | ||
| to_new_issue: Open an issue | ||
| or: Or, | ||
| to_guidelines: learn how to contribute. | ||
| to_guidelines: learn how to contribute and submit a pull request. | ||
| button: Make a contribution |
There was a problem hiding this comment.
Missing to_issues key definition.
The contribution_cta section is missing the to_issues key that is referenced in includes/contribution.html on line 14:
{% data ui.contribution_cta.to_issues %}This will cause a rendering error or empty output since to_issues is not defined in this YAML file. You have to_new_issue defined (line 64), but that's a separate key used on line 15 of the HTML template.
🔧 Proposed fix: Add the missing `to_issues` key
contribution_cta:
title: Help us make these docs great!
body: All GitHub docs are open source. See something that's wrong or unclear?
to_new_issue: Open an issue
+ to_issues: or open an issue.
or: Or,
to_guidelines: learn how to contribute and submit a pull request.
button: Make a contribution🤖 Prompt for AI Agents
In `@data/ui.yml` around lines 61 - 67, The contribution_cta block is missing the
to_issues key referenced by the template (ui.contribution_cta.to_issues), which
causes rendering errors; update the contribution_cta mapping in data/ui.yml by
adding a to_issues entry (similar to to_new_issue) with the appropriate
label/URL text so includes/contribution.html can read
ui.contribution_cta.to_issues; ensure the new key name is exactly to_issues and
placed alongside title, body, to_new_issue, to_guidelines, or, and button.
| <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/blob/main/CONTRIBUTING.md" target="_blank">{% data ui.contribution_cta.to_guidelines %}</a><a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_issues %}</a></p> | ||
| <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_new_issue %}</a></p> |
There was a problem hiding this comment.
Missing separator between links and duplicate CTAs.
Several issues on these lines:
-
Line 14: The two anchor tags are concatenated without any separator text between them. This will render the links directly adjacent (e.g., "learn how to contribute and submit a pull request.or open an issue.").
-
Lines 14-15: Both paragraphs start with
{% data ui.contribution_cta.or %}("Or,") and both link to the same URL (https://github.com/github/docs/issues/new/choose), creating redundant CTAs.
🔧 Proposed fix: Remove duplicate and fix link structure
If the intent is to have one line with guidelines link and another for opening issues:
- <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/blob/main/CONTRIBUTING.md" target="_blank">{% data ui.contribution_cta.to_guidelines %}</a><a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_issues %}</a></p>
- <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_new_issue %}</a></p>
+ <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/blob/main/CONTRIBUTING.md" target="_blank">{% data ui.contribution_cta.to_guidelines %}</a></p>
+ <p class="color-text-secondary f6 mt-2"><a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_new_issue %}</a></p>📝 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.
| <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/blob/main/CONTRIBUTING.md" target="_blank">{% data ui.contribution_cta.to_guidelines %}</a><a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_issues %}</a></p> | |
| <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_new_issue %}</a></p> | |
| <p class="color-text-secondary f6 mt-2">{% data ui.contribution_cta.or %} <a href="https://github.com/github/docs/blob/main/CONTRIBUTING.md" target="_blank">{% data ui.contribution_cta.to_guidelines %}</a></p> | |
| <p class="color-text-secondary f6 mt-2"><a href="https://github.com/github/docs/issues/new/choose" target="_blank">{% data ui.contribution_cta.to_new_issue %}</a></p> |
🤖 Prompt for AI Agents
In `@includes/contribution.html` around lines 14 - 15, Remove the duplicate CTA
paragraph and fix the concatenated anchors: keep a single paragraph using the
template tokens {% data ui.contribution_cta.or %}, {% data
ui.contribution_cta.to_guidelines %} and {% data
ui.contribution_cta.to_new_issue %} (not {% data ui.contribution_cta.to_issues
%} twice), and insert a visible separator (e.g., a space and the word "or" via
{% data ui.contribution_cta.or %} or a middot) between the two <a> tags so the
guidelines link ({% data ui.contribution_cta.to_guidelines %}) and the new-issue
link ({% data ui.contribution_cta.to_new_issue %}) are not concatenated; remove
the extra paragraph that duplicates the CTA.
2 participants
Why:
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
datadirectory.For content changes, I have completed the self-review checklist.
Summary by CodeRabbit
Release Notes
Documentation
New Features
✏️ Tip: You can customize this high-level summary in your review settings.