docs(test-suite): fix broken CONTRIBUTING.md relative link by feizhuzheng · Pull Request #4474 · firecrawl/firecrawl · GitHub
Skip to content

docs(test-suite): fix broken CONTRIBUTING.md relative link - #4474

Open
feizhuzheng wants to merge 1 commit into
firecrawl:mainfrom
feizhuzheng:fix/test-suite-contributing-link
Open

docs(test-suite): fix broken CONTRIBUTING.md relative link#4474
feizhuzheng wants to merge 1 commit into
firecrawl:mainfrom
feizhuzheng:fix/test-suite-contributing-link

Conversation

@feizhuzheng

@feizhuzheng feizhuzheng commented Sep 1, 2026

Copy link
Copy Markdown

Problem

apps/test-suite/README.md links to the project's main contributing guide with a single-dot-dot relative path:

Please refer to the project's main [CONTRIBUTING.md](../CONTRIBUTING.md) file for guidelines...

From apps/test-suite/, ../CONTRIBUTING.md resolves to apps/CONTRIBUTING.md, which does not exist. The only CONTRIBUTING.md in the repo lives at the root, so the link 404s on GitHub (and anywhere the README is rendered relative to its own path).

Fix

Point the link one more level up so it reaches the root file:

[CONTRIBUTING.md](../../CONTRIBUTING.md)

The surrounding sentence already says "the project's main CONTRIBUTING.md", so the intended target is unambiguously the root file.

How to verify

From the repo root:

# broken target (what the current link points at) -> absent
test -f apps/CONTRIBUTING.md || echo "apps/CONTRIBUTING.md: MISSING"
# fixed target -> present
test -f CONTRIBUTING.md && echo "CONTRIBUTING.md (root): OK"

Or open apps/test-suite/README.md on GitHub and click the link before/after: ../CONTRIBUTING.md 404s, ../../CONTRIBUTING.md lands on the root guide.

Docs-only, one line changed.


Summary by cubic

Fixes the broken relative link in apps/test-suite/README.md so it points to the root CONTRIBUTING.md instead of the non-existent apps/CONTRIBUTING.md.

Written for commit 77167dd. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot 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.

No issues found across 1 file

Re-trigger cubic

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant