Skip to content

docs: remove dependency notes section from README#172

Merged
rchalamala merged 1 commit into
mainfrom
devin/1782110159-remove-dep-note
Jun 22, 2026
Merged

docs: remove dependency notes section from README#172
rchalamala merged 1 commit into
mainfrom
devin/1782110159-remove-dep-note

Conversation

@devin-ai-integration

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

Copy link
Copy Markdown
Contributor

Summary

Remove the "Dependency notes" section from README.md (the preact/@preact/signals peer-dependency note for Schedule-X).

Link to Devin session: https://app.devin.ai/sessions/c64519508c034ff78cfbdd2b6c217bbd
Requested by: @rchalamala


Open in Devin Review

Co-Authored-By: Rahul Chalamala <22563365+rchalamala@users.noreply.github.com>
@rchalamala rchalamala self-assigned this Jun 22, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@devin-ai-integration devin-ai-integration Bot left a comment

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.

Devin Review found 1 potential issue.

Open in Devin Review

Comment thread README.md
@@ -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.

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.

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
caltech-dev 7c900f8 Commit Preview URL

Branch Preview URL
Jun 22 2026, 06:37 AM

@rchalamala rchalamala merged commit 40729d7 into main Jun 22, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant