chore(docs): Clean up readme and contributing guide #14
Conversation
📝 WalkthroughWalkthroughAdds a new CONTRIBUTING.md with detailed local development instructions (mise/manual), Poetry-based environment and dependency management, pre-commit hooks, and testing workflows (nox, Docker, and local test scripts). Overhauls README.md to a concise project overview with a centered header block, simplified Installation section, and moves development, testing, and release procedures into CONTRIBUTING.md. Adds Contributing, License, and Support sections. No code or exported API changes. Sequence Diagram(s)Possibly related PRs
Suggested reviewers
Pre-merge checks❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.18.1)README.md1-1: First line in a file should be a top-level heading (MD041, first-line-heading, first-line-h1) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
🔇 Additional comments (1)
Comment |
|
📦 Python package built successfully!
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #14 +/- ##
==========================================
- Coverage 76.60% 76.57% -0.04%
==========================================
Files 99 99
Lines 5476 5473 -3
Branches 748 748
==========================================
- Hits 4195 4191 -4
- Misses 1281 1282 +1 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
docs/_assets/deepnote-toolkit-cover-image.pngis excluded by!**/*.png
📒 Files selected for processing (2)
CONTRIBUTING.md(1 hunks)README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
3-3: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
8-8: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
37-37: Dollar signs used before commands without showing output
(MD014, commands-show-output)
43-43: Dollar signs used before commands without showing output
(MD014, commands-show-output)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Build and push artifacts for Python 3.10
- GitHub Check: Build and push artifacts for Python 3.12
- GitHub Check: Test - Python 3.11
- GitHub Check: Build and push artifacts for Python 3.9
- GitHub Check: Build and push artifacts for Python 3.11
- GitHub Check: Test - Python 3.9
- GitHub Check: Test - Python 3.10
- GitHub Check: Typecheck - 3.12
🔇 Additional comments (5)
CONTRIBUTING.md (2)
30-31: Clarify Python version guidance for manual setup.Line 30 suggests Python 3.10, but the mise setup (line 16) installs Python 3.12. This inconsistency may confuse developers. Consider whether 3.10 is intentional (for backwards compatibility) or if both should target 3.12 for consistency.
1-244: Comprehensive and well-structured contribution guide.The documentation effectively covers local development, testing workflows, dependency management, and maintainer procedures. The dual-path setup (mise vs. manual) accommodates different developer preferences. The troubleshooting section (lines 65–73) and detailed Docker workflow guidance add practical value.
README.md (3)
32-40: Installation section is clear and actionable.The pip install guidance with optional server extras is straightforward. The security note on line 65 about Jupyter authentication appropriately flags local-dev-only usage.
43-65: Local development quickstart is practical.The Poetry-based CLI examples are concise and cover common tasks (install, help, run server, config). The emphasis on Poetry during development complements the CONTRIBUTING.md guide well.
67-87: Contributing section effectively redirects to detailed guide.The brief pointer to CONTRIBUTING.md keeps the README lean while signposting developers to comprehensive setup and testing instructions. License and Support sections are clear and link to relevant resources.
|
🚀 Review App Deployment Started
|
m1so
dismissed stale reviews from mfranczel and coderabbitai[bot]
via
1366279
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
README.md (1)
64-67: Remove trailing whitespace (MD009).Line 66 contains exactly one trailing space. Remove it unless intentionally creating a markdown line break (which requires exactly two trailing spaces).
For more details on how to set up the local development environment and contribute, -see [contributing guide](./CONTRIBUTING.md). +see [contributing guide](./CONTRIBUTING.md).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
32-32: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
66-66: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🔇 Additional comments (1)
README.md (1)
64-77: Contributing and support sections look good.The redirect to CONTRIBUTING.md is clear, and the support section appropriately surfaces documentation, issues, and security guidance.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
65-65: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
- GitHub Check: Build and push artifacts for Python 3.12
- GitHub Check: Build and push artifacts for Python 3.10
- GitHub Check: Build and push artifacts for Python 3.11
- GitHub Check: Build and push artifacts for Python 3.9
- GitHub Check: Test - Python 3.11
- GitHub Check: Typecheck - 3.10
- GitHub Check: Typecheck - 3.9
🔇 Additional comments (2)
README.md (2)
1-84: Clean restructuring aligns well with docs-to-contributing split.The new README is concise, navigable, and appropriately delegates detailed setup/development workflows to CONTRIBUTING.md. The centered header with image and nav links provides strong branding. Features section is clearer as a bullet list. Installation and CLI quickstart sections are properly formatted with correct blank lines before code fences (fixing prior MD031 violations). Overall structure is maintainable and user-friendly.
3-3: Cover image file verified. The image file exists at the expected path—no action needed.
Co-authored-by: James Hobbs <15235276+jamesbhobbs@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit