Prioritize consistent, clear, and beginner-friendly terminology throughout your codebase and documentation. Choose names that are intuitive for users rather than technically precise but confusing. Maintain consistency with established patterns and style guidelines.
Key principles:
ViteConfig
instead of UserConfig
when the context makes it clearer that it’s Vite configuration~/
over @/
refreshEvery
to match native functions rather than pollEvery
)Example of good terminology consistency:
// Good - clear and consistent
interface ViteConfig {
clientSide: boolean;
serverSide: boolean;
}
// Avoid - technically correct but less intuitive
interface UserConfig {
frontEnd: boolean;
backEnd: boolean;
}
Enter the URL of a public GitHub repository