Current Behavior
Over time, a few minor typos have slipped into our directory and file naming conventions in the src/ directory. Examples include CssBaseLine (incorrect MUI spelling), SocialMedial (extra 'l'), and responsive-coulmns.tsx/ (misspelled word plus an incorrect folder extension). While these do not break functionality, they are confusing for developers and violate standard naming conventions.
Expected Behavior
All directories and files should be correctly spelled and follow proper casing conventions (e.g., CssBaseline, SocialMedia, README.md).
Screenshots/Logs
N/A
Environment
N/A (Codebase-level hygiene issue)
📋 Checklist of Required Renames
⚠️ Important Notes for Contributors
- Update Imports: Whenever you rename a file or folder, please ensure you update the corresponding imports in their parent
index.ts / index.tsx files (and anywhere else they might be imported).
- Git Case-Sensitivity: If you are on macOS or Windows, Git might not recognize a simple casing change (e.g.,
readme.md to README.md). You may need to do a two-step rename:
git mv readme.md readme-temp.md
git mv readme-temp.md README.md
- Use
git mv: Please use git mv for the renames so Git tracks the file history correctly instead of showing them as deleted/added.
🧪 How to Test
- Run
npm run build (or yarn build) to ensure there are no broken imports or missing module errors.
- Optionally run
npm run test (or yarn test) to ensure nothing is broken.
Contributor Guides and Resources
Current Behavior
Over time, a few minor typos have slipped into our directory and file naming conventions in the
src/directory. Examples includeCssBaseLine(incorrect MUI spelling),SocialMedial(extra 'l'), andresponsive-coulmns.tsx/(misspelled word plus an incorrect folder extension). While these do not break functionality, they are confusing for developers and violate standard naming conventions.Expected Behavior
All directories and files should be correctly spelled and follow proper casing conventions (e.g.,
CssBaseline,SocialMedia,README.md).Screenshots/Logs
N/A
Environment
N/A (Codebase-level hygiene issue)
📋 Checklist of Required Renames
src/base/CssBaseLine/→src/base/CssBaseline/src/custom/TypingFilter/TypingFIlterInput.tsx→TypingFilterInput.tsxsrc/custom/TypingFilter/TypingFIlters.tsx→TypingFilters.tsxsrc/custom/Prompt/promt-component.tsx→prompt-component.tsxsrc/custom/Helpers/ResponsiveColumns/responsive-coulmns.tsx/→responsive-columns/src/icons/SocialMedial/→src/icons/SocialMedia/src/custom/readme.md→src/custom/README.mdsrc/schemas/readme.md→src/schemas/README.mdindex.ts/index.tsxfiles (and anywhere else they might be imported).readme.mdtoREADME.md). You may need to do a two-step rename:git mv: Please usegit mvfor the renames so Git tracks the file history correctly instead of showing them as deleted/added.🧪 How to Test
npm run build(oryarn build) to ensure there are no broken imports or missing module errors.npm run test(oryarn test) to ensure nothing is broken.Contributor Guides and Resources