Skip to content

Update contributing guide to mention symlinks Git option - #13866

Merged
Viicos merged 1 commit into
mainfrom
vp/symlink-contributing
Sep 25, 2026
Merged

Viicos merged 1 commit into
mainfrom
vp/symlink-contributing

Conversation

@Viicos

@Viicos Viicos commented Sep 25, 2026

Copy link
Copy Markdown
Member

Change Summary

Closes #13838.

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

@Viicos Viicos added the relnotes-ignore Omit this PR from the release notes. label Sep 25, 2026
@Viicos
Viicos enabled auto-merge (squash) September 25, 2026 02:12
Comment thread docs/contributing.md
# You can run `make help` to see more options.
```

The `pydantic-core` test suite is located in `tests/pydantic-core`, as a symlink. For it to work, you may need to

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Low docs/contributing.md:113

The documented path tests/pydantic-core does not exist; the test suite symlink is tests/pydantic_core, so contributors following this guidance cannot access the tests. Use the repository's underscore-separated path.

Suggested change
The `pydantic-core` test suite is located in `tests/pydantic-core`, as a symlink. For it to work, you may need to
The `pydantic-core` test suite is located in `tests/pydantic_core`, as a symlink. For it to work, you may need to
🚀 Reply "fix it for me" or copy this AI Prompt for your agent:
In file @docs/contributing.md around line 113:

The documented path `tests/pydantic-core` does not exist; the test suite symlink is `tests/pydantic_core`, so contributors following this guidance cannot access the tests. Use the repository's underscore-separated path.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry, I'm unable to act on this request because you do not have permissions within this repository.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying pydantic-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0c399c0
Status: ✅  Deploy successful!
Preview URL: https://ebdcd74e.pydantic-docs.pages.dev
Branch Preview URL: https://vp-symlink-contributing.pydantic-docs.pages.dev

View logs

@Viicos
Viicos merged commit a9a0e1d into main Sep 25, 2026
89 checks passed
@Viicos
Viicos deleted the vp/symlink-contributing branch September 25, 2026 02:18
@github-actions

Copy link
Copy Markdown
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@codspeed

codspeed Bot commented Sep 25, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 216 untouched benchmarks
⏩ 163 skipped benchmarks1


Comparing vp/symlink-contributing (0c399c0) with main (5cca217)

Open in CodSpeed

Footnotes

  1. 163 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

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

Labels

relnotes-ignore Omit this PR from the release notes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Half the test suite is silently skipped on a Windows checkout without symlink privilege (tests/pydantic_core)

1 participant