search

conventional-commits / conventionalcommits.org

The conventional commits specification
https://conventionalcommits.org
MIT License
6.71k stars 520 forks source link

Should there be (a11y) commit type? How do you address accessibility UI related changes? #577

Open webmatrixxxl opened 3 months ago

webmatrixxxl commented 3 months ago

Hello!

In the Front-End world recently because of the European Accessibility Act, we have been required (for good) to implement a lot of accessibility across components and pages.

And I started wondering how we should address accessibility in the commit messages.

a11y(checkout): add alt text to card types in checkout

or

accessibility(checkout): add alt text to card types in checkout

or we can stick to

feat(checkout): add alt text to card types in checkout

or maybe

chore(checkout): add alt text to card types in checkout

Personally, I kind of prefer the first one. I'm thinking about the feat and fix in the scope of functionality and accessibility is on top of that.

I have seen this in another project as well: link

What do you think?

henrikhelmers commented 3 months ago

On the one hand, accessibility should be part of code quality (be it by adding alt text or correctly implementing design), which would make "chore" correct.

On the other hand it would be valuable to be able to point at commits related to accessibility to document effort in that area. I also belive that as the amount of awareness (and legislation) increase, the amount of commits directly related to accessibility will as well.