Sass coding guidelines for BigCommerce themes, emphasizing structured class names, low specificity, and component-driven development.
bigcommerce/sass-style-guide is a comprehensive set of coding guidelines for writing Sass in BigCommerce themes. It establishes a consistent, component-driven approach to creating maintainable, scalable, and performant CSS through structured naming conventions, formatting rules, and architectural principles. The guide prioritizes code that looks as if written by a single person, emphasizing low specificity, reusability, and separation of concerns.
Frontend developers and theme designers building or maintaining BigCommerce themes using Sass. It is specifically tailored for teams working within the BigCommerce ecosystem who need to adhere to a unified style for consistency and maintainability.
Developers choose this guide because it provides a battle-tested, opinionated framework for Sass that enforces consistency and reduces technical debt in large-scale theme development. Its unique selling point is its deep integration with BigCommerce's design system, offering specific conventions for component-driven architecture, variable management, and folder structure that align with the platform's needs.
Sass coding guidelines for BigCommerce themes
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Follows SUIT CSS methodology with camelCase component names and meaningful hyphens, decoupling presentation from document semantics and keeping specificity low for maintainability.
Advocates for equal, low-specificity selectors and warns against over-nesting, reducing DOM walking and improving rendering performance based on Google's best practices.
Provides detailed guidelines on indentation, spacing, commenting, and alphabetical declaration order, ensuring code readability and consistency across large teams.
Encourages building components as reusable mixins with optional CSS output, promoting DRY principles and scalable architecture through patterns like pluralized containers.
Prescribes clear folder hierarchies for settings, tools, components, utilities, and layouts, including a 'shame' folder for hacky code, facilitating maintainability in micro-apps.
Relies heavily on BigCommerce's global variables for colors, z-index, and fonts, making it less adaptable for projects outside their ecosystem without significant modification.
Enforces strict conventions on naming, formatting, and structure (e.g., alphabetical declaration order), which can stifle creativity and require full team buy-in.
The prescribed folder structure and requirement to manage component-scoped variables add initial setup overhead, especially for smaller teams or those new to structured Sass.
Focuses on traditional Sass without addressing modern CSS features like Grid, CSS-in-JS, or utility-first frameworks, which may be more suitable for contemporary workflows.