docs: add Troubleshooting section to CONTRIBUTING.md - #77
Merged
Conversation
Signed-off-by: ChickenisLegit <ChickenisLegit@users.noreply.github.com>
github-actions
Bot
added
the
area:docs
alphacrack
approved these changes
Aug 11, 2026
alphacrack
left a comment
alphacrack
left a comment
Owner
There was a problem hiding this comment.
✅ Approved — CI green (20/20) and a docs e2e pass.
Review: Clean, correctly-scoped addition of a ## Troubleshooting section to CONTRIBUTING.md covering the three real setup gotchas (0.0.0+unknown from a shallow clone breaking setuptools-scm, the numpy stub / mypy-3.12 issue, and the generated _version.py). Placed sensibly between Development setup and CI gates. Based on current main — 1 file, no conflicts. Resolves #55.
E2E (proportionate for docs):
- CI: 20/20 green (lint, mypy, full test matrix, smoke, build, CodeQL, security).
- Hygiene: no trailing whitespace, final newline present, markdown structure well-formed — passes the repo's pre-commit hooks.
Thanks for the clear, accurate writeup, @ChickenisLegit — and welcome! 🎉
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #55