Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adjust naming per recent conversation #1518

Closed
3 tasks
thekaveman opened this issue Jul 11, 2023 · 0 comments · Fixed by #1533
Closed
3 tasks

Adjust naming per recent conversation #1518

thekaveman opened this issue Jul 11, 2023 · 0 comments · Fixed by #1533
Assignees
@thekaveman
Labels
chore Chores and tasks for code cleanup, dev experience, admin/configuration settings, etc. front-end HTML/CSS/JavaScript and Django templates i18n Copy: Language files or Django i18n framework
Milestone
UI composition im...

Comments

@thekaveman
Copy link
Member

thekaveman commented Jul 11, 2023 •
edited

We agreed that all templates should be named with kebab-case.

Additionally, name components should increase in specificity:

  • from Left --> Right
  • with different components separated by double-dash --

Examples:

  • agency-index.html
  • modal.html
  • modal--agency-selector.html

Acceptance Criteria

  • All templates for includes and pages use kebab-case naming
  • Template names increase in specificity according to the above rules
  • Block names within templates also use kebab-case
@thekaveman thekaveman added the chore Chores and tasks for code cleanup, dev experience, admin/configuration settings, etc. label Jul 11, 2023
@thekaveman thekaveman self-assigned this Jul 11, 2023
@thekaveman thekaveman changed the title Adjust template naming per recent conversation Adjust naming per recent conversation Jul 11, 2023
@thekaveman thekaveman added the front-end HTML/CSS/JavaScript and Django templates label Jul 13, 2023
@thekaveman thekaveman mentioned this issue Jul 13, 2023
Merged
@thekaveman thekaveman added the i18n Copy: Language files or Django i18n framework label Jul 14, 2023
@thekaveman thekaveman mentioned this issue Aug 1, 2023
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thekaveman thekaveman

Labels
chore Chores and tasks for code cleanup, dev experience, admin/configuration settings, etc. front-end HTML/CSS/JavaScript and Django templates i18n Copy: Language files or Django i18n framework
Projects
Digital Services
Status: Done
Milestone
UI composition improvements [eng]
Development

Successfully merging a pull request may close this issue.

Fix: template and msgid naming cal-itp/benefits
1 participant
@thekaveman