Skip to content

docs: fix broken TOC anchor and dead internal link in CONTRIBUTING.md#7709

Open
Goutham-Annem wants to merge 1 commit into
karmada-io:masterfrom
Goutham-Annem:docs/7644-fix-contributing-toc-anchors
Open

docs: fix broken TOC anchor and dead internal link in CONTRIBUTING.md#7709
Goutham-Annem wants to merge 1 commit into
karmada-io:masterfrom
Goutham-Annem:docs/7644-fix-contributing-toc-anchors

Conversation

@Goutham-Annem

Copy link
Copy Markdown

What type of PR is this?

/kind documentation

What this PR does / why we need it

Two issues in CONTRIBUTING.md:

  1. The Table of Contents has a [Testing](#testing) entry, but no ## Testing heading exists in the document — the link is broken.

  2. 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 Workflow section, 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

- 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>
Copilot AI review requested due to automatic review settings July 5, 2026 16:27
@karmada-bot karmada-bot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. labels Jul 5, 2026
@karmada-bot karmada-bot requested review from mszacillo and zach593 July 5, 2026 16:27
@karmada-bot

Copy link
Copy Markdown
Contributor

Invalid commit message issues detected

Invalid commit messages

Keywords which can automatically close issues and hashtag(#) mentions are not allowed.

  • 480376e docs: fix broken TOC anchor and dead internal link in CONTRIBUTING.md

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.

@karmada-bot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kevin-wangzefeng for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, 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

  • Table of Contents Cleanup: Removed the broken 'Testing' anchor link from the Table of Contents in CONTRIBUTING.md.
  • Internal Link Correction: Updated a self-referencing link to point correctly to the 'Contributor Workflow' section.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@karmada-bot karmada-bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 5, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 42.06%. Comparing base (09eb45a) to head (480376e).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

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     
Flag Coverage Δ
unittests 42.06% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/documentation Categorizes issue or PR as related to documentation. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix broken TOC anchors in CONTRIBUTING.md

4 participants