docs: fix broken TOC anchor and dead internal link in CONTRIBUTING.md#7709
docs: fix broken TOC anchor and dead internal link in CONTRIBUTING.md#7709Goutham-Annem wants to merge 1 commit into
Conversation
- Remove the [Testing](#testing) TOC entry which has no matching heading - Fix [Contributing](#contributing) self-link to correctly point to [Contributor Workflow](#contributor-workflow) Fixes karmada-io#7644 Signed-off-by: Goutham Annem <gouthemannem@gmail.com>
|
Invalid commit message issues detected Invalid commit messagesKeywords which can automatically close issues and hashtag(#) mentions are not allowed.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the quality of the project's documentation by resolving broken navigation links within the CONTRIBUTING.md file. By removing an invalid Table of Contents entry and correcting an internal reference, the user experience for new contributors is streamlined. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the CONTRIBUTING.md file by removing a defunct 'Testing' section from the Contributor Workflow table of contents and correcting a broken link reference to point to '#contributor-workflow' instead of '#contributing'. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
Pull request overview
Fixes two broken/low-value internal links in CONTRIBUTING.md to improve navigation for contributors (aligning the TOC and cross-references with actual headings in the document).
Changes:
- Removed the
[Testing](#testing)entry from the Table of Contents since no corresponding “Testing” section exists. - Replaced a redundant self-link
[Contributing](#contributing)with a meaningful link to the actual workflow section:[Contributor Workflow](#contributor-workflow).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #7709 +/- ##
=======================================
Coverage 42.06% 42.06%
=======================================
Files 879 879
Lines 54831 54831
=======================================
+ Hits 23063 23065 +2
+ Misses 30023 30022 -1
+ Partials 1745 1744 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
What type of PR is this?
/kind documentation
What this PR does / why we need it
Two issues in CONTRIBUTING.md:
The Table of Contents has a
[Testing](#testing)entry, but no## Testingheading exists in the document — the link is broken.Line 63 has
[Contributing](#contributing)which is a useless self-link that points back to the document's own title. It should point to the## Contributor Workflowsection, which describes the actual PR workflow.Which issue(s) this PR fixes
Fixes #7644
Does this PR introduce a user-facing change?
No
Signed-off-by: Goutham Annem gouthemannem@gmail.com