creativecommons / vocabulary

A cohesive system of design for Creative Commons
https://vocabulary-docs.netlify.app
Creative Commons Zero v1.0 Universal
8 stars 67 forks source link

[Feature] consistently use single quotes in CSS files #326

Open shivam8112005 opened 3 days ago

shivam8112005 commented 3 days ago

Problem

Inconsistent use of quotation styles in normalize.css file (single vs. double quotes) can reduce code readability, introduce unnecessary diffs in version control, and complicate style enforcement across teams. This inconsistency also makes it harder to apply automated linting rules. with reference to #322

Description

Standardizing the use of single quotes in the normalize.css file ensures consistency across the codebase. This improvement enhances readability, simplifies collaboration, and allows for seamless integration with automated linting tools.

Alternatives

  1. Stick with double quotes: While valid, this approach may not align with established preferences and would require similar enforcement.
  2. Allow both styles: This would avoid standardization but negates the benefits of readability, linting, and reduced version control diffs.

Additional context

Using single quotes aligns normalize.css with broader project conventions if single quotes are preferred across the CSS codebase. It also integrates well with stylelint rules, such as string-quotes: 'single', to enforce consistency.

Implementation

possumbilities commented 9 hours ago

@shivam8112005 As this is an external dependency and is "vendored", I'm not sure it would be prudent to reformat the file to match this project's formatting preferences; since that may make it harder to track any upstream changes over time.

I'm going to leave this as a Discussion for now in case others have counter-arguments; but for the time being I think it best we not try to reformat vendor files.

shivam8112005 commented 9 hours ago

@possumbilities ohk got it