Skip to content

Conversation

@davewaring
Copy link
Contributor

Summary

  • Add RENAME_CHECKLIST.md with step-by-step renaming guide for new developers
  • Add prominent warnings about plugin vs module naming (they must differ!)
  • Reference checklist from webpack.config.js comments

Problem

First-time plugin developers frequently hit these gotchas:

  1. Not knowing all the places to rename when customizing the template
  2. Using the same name for plugin and module (causes BrainDrive to fail to distinguish them)
  3. Forgetting to update import paths after renaming files

Solution

  • RENAME_CHECKLIST.md: A checkbox-style guide developers can follow step-by-step
  • Stronger code comments: Visual warnings in lifecycle_manager.py and webpack.config.js

Note

npm deprecation warnings (inflight, rimraf, glob) are from transitive dependencies in webpack's dependency tree. Fixing those would require major version updates - recommend addressing separately if needed.

Test plan

  • Clone template, follow checklist to rename
  • Verify build succeeds after renaming
  • Verify warnings are visible in code

Generated with Claude Code

- Add RENAME_CHECKLIST.md with step-by-step renaming guide
- Add prominent warnings about plugin vs module naming (must differ)
- Reference checklist from webpack.config.js comments

These changes address common gotchas that trip up first-time plugin developers.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.

2 participants