docs: add contributing section about cache busting in dev#1617
docs: add contributing section about cache busting in dev#1617
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
📝 WalkthroughWalkthroughAdds a documentation subsection "Clearing caches during development" to CONTRIBUTING.md. Describes that Nitro persists 🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| ```bash | ||
| # Clear all Nitro handler caches | ||
| rm -rf .nuxt/cache/nitro/handlers/ | ||
|
|
||
| # Clear a specific handler cache (e.g. picks) | ||
| rm -rf .nuxt/cache/nitro/handlers/npmx-picks/ | ||
| ``` |
There was a problem hiding this comment.
Minor: comment label doesn't match the directory name in the example.
Line 136 says (e.g. picks) but the path immediately below it is npmx-picks/. Aligning the comment with the actual directory name avoids confusion.
✏️ Suggested fix
-# Clear a specific handler cache (e.g. picks)
+# Clear a specific handler cache (e.g. npmx-picks)
rm -rf .nuxt/cache/nitro/handlers/npmx-picks/| ) | ||
| ``` | ||
|
|
||
| The `.cache/` directory is a separate storage mount used for fetch-cache and atproto data. |
There was a problem hiding this comment.
Minor: .cache/ note lacks actionable context.
The note mentions the directory but leaves contributors without any guidance. Someone hitting stale fetch-cache or atproto data won't know whether or how to clear it. Consider either scoping the note ("the commands above do not affect .cache/") or adding a corresponding clear command.
✏️ Suggested expansion
-The `.cache/` directory is a separate storage mount used for fetch-cache and atproto data.
+The `.cache/` directory is a separate storage mount used for fetch-cache and atproto data. The commands above do not affect it; to clear it, run `rm -rf .cache/`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The `.cache/` directory is a separate storage mount used for fetch-cache and atproto data. | |
| The `.cache/` directory is a separate storage mount used for fetch-cache and atproto data. The commands above do not affect it; to clear it, run `rm -rf .cache/`. |
4 participants
🔗 Linked issue
N/A - I learned this myself the hard way and decided to document it :)
🧭 Context
It isn't obvious how caching works in local dev
📚 Description
This adds a section to CONTRIBUTING.md about where caches are persisted in local dev and how to clear them.