Skip to content

docs: remove dependency notes section from README #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rchalamala merged 1 commit into from
Jun 22, 2026
Merged

docs: remove dependency notes section from README #172

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,3 @@ Made with ❤️ by [Rahul](https://github.com/rchalamala/), [Eric](https://gith
In addition, thanks to [Armeet](https://github.com/armeetjatyani/) and others for suggestions/contributions!

Favicon art by Audrey Wong.

@devin-ai-integration devin-ai-integration Bot Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

🚩 Removing documentation guard for non-obvious peer dependencies

The deleted section explicitly warned maintainers that preact and @preact/signals are peer dependencies of @schedule-x/* and must not be removed, despite never appearing in src/ imports. These dependencies are still present in package.json:12,21 and are required at runtime by @schedule-x/calendar (confirmed in package-lock.json:2931-2932). Without this note, a future contributor running a dependency audit or cleanup could reasonably conclude these are unused and remove them, breaking the Schedule-X calendar in src/Planner.tsx. Consider keeping this note somewhere (e.g., as a comment in package.json or in a contributing guide) if the README isn't the right place.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@devin-ai-integration devin-ai-integration Bot Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This removal was explicitly requested by the repo owner.


## Dependency notes

- `preact` and `@preact/signals` are never imported in `src/` directly — they are runtime peer dependencies of the Schedule-X calendar (`@schedule-x/*`) and must not be removed.