main.mdc 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. ---
  2. description: Tabler Project Rules
  3. globs:
  4. alwaysApply: true
  5. ---
  6. ## Documentation Standards
  7. - Always write documentation in English (not Polish) for technical content
  8. - Use clear, descriptive headings with proper hierarchy (##, ###)
  9. - Include practical examples with code snippets
  10. - Add explanations for each component's purpose and usage
  11. - Use consistent formatting for code blocks and examples
  12. ## CSS/SCSS Guidelines
  13. - Follow Tabler's CSS custom properties pattern: `--#{$prefix}component-property`
  14. - Use semantic class names that describe purpose, not appearance
  15. - Maintain consistent spacing and indentation in SCSS files
  16. - Group related styles together with clear comments
  17. - Use Bootstrap-compatible class naming conventions
  18. ## Component Documentation Structure
  19. - Start with a brief description of the component's purpose
  20. - Show basic usage examples first
  21. - Include variations and modifiers
  22. - Add accessibility considerations where relevant
  23. - Provide code examples that are copy-paste ready
  24. ## File Organization
  25. - Keep documentation files in `docs/content/ui/components/`
  26. - Use consistent naming: lowercase with hyphens
  27. - Include frontmatter with title, summary, and description
  28. - Link to Bootstrap documentation when relevant
  29. ## Code Examples
  30. - Use Liquid templating syntax for dynamic examples
  31. - Include both HTML and rendered output
  32. - Show responsive behavior where applicable
  33. - Demonstrate proper accessibility attributes
  34. ## Git Commit Messages
  35. - Use English for commit messages
  36. - Follow conventional commit format when possible
  37. - Be descriptive about what was changed and why
  38. ## Project-Specific Conventions
  39. - Tabler uses Bootstrap 5 as a foundation
  40. - Custom components extend Bootstrap functionality
  41. - Documentation should be comprehensive but concise
  42. - Examples should be practical and immediately usable