Consolidate contributing guide + fix test-running docs#399
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates the contributing guide to a single canonical source (/CONTRIBUTING.md) and updates documentation cross-links so the contributing content stays consistent across GitHub and the rendered docs site.
Changes:
- Replaced
docs/development/contributing.mdwith apymdownx.snippetstransclusion of the rootCONTRIBUTING.md. - Updated references in the development guide and
CLAUDE.mdto point at the canonical contributing guide location. - Fixed previously broken contributing/development/user-guide links in
CONTRIBUTING.mdby switching to the published docs URLs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/development/development.md | Updates “Looking to contribute?” references to point at the published Contributing Guide page. |
| docs/development/contributing.md | Replaces duplicated content with a snippets include of the root CONTRIBUTING.md. |
| CONTRIBUTING.md | Fixes broken internal links by pointing to the published docs URLs. |
| CLAUDE.md | Updates the contributing-guide reference to the canonical root CONTRIBUTING.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Two related developer-documentation cleanups.
1. Consolidate the contributing guide
The contributing guide existed as two divergent copies — root
CONTRIBUTING.mdanddocs/development/contributing.md(121 lines each, with hand-adjusted and partly broken internal links). This consolidates to a single source of truth:CONTRIBUTING.md(the conventional, GitHub-surfaced location).docs/development/contributing.mdis now a one-linepymdownx.snippetsinclude (--8<-- "CONTRIBUTING.md") so the page stays in the nav with no duplicated content. (Symlinking was tried first, but zensical 0.0.34 silently skips symlinked files.)CONTRIBUTING.md; cross-references now use absolute published-docs URLs so they resolve both on GitHub and in the rendered site. Fixed the two broken../CONTRIBUTING.mdlinks indevelopment.md; pointedCLAUDE.mdat the canonical root file.README.mdalready linked to root.zensical build(no warnings; the page renders the canonical content).2. Fix the test-running docs (and make
pytestwork)Bare
pytestfrom the repo root failed to collect — it recursed intopackages/*/tests, hitting cross-package test-module name collisions (ImportPathMismatchError) — yet the docs told contributors to runpytest.[tool.pytest.ini_options] testpaths = ["tests"]to the rootpyproject.tomlso barepytest/uv run pytestruns the application suite cleanly. Explicit paths (e.g.pytest packages/jabs-core/tests) still work and override the default.CONTRIBUTING.mdanddocs/development/development.mdto distinguish the main suite from the per-package suites (matching the per-package list already inCLAUDE.md).pytestnow collects and passes the fulltests/suite (710 tests); explicit package paths still collect.Out of scope:
docs/development/development.mdalso has a separate pre-existing broken link touser-guide.md(unrelated) — left for a follow-up.