FlowingCode / DevelopmentConventions

Repository hosting conventions, decisions and documentation related to best coding practices that can be utilized in development projects
Apache License 2.0
9 stars 0 forks source link

What type to use for visual content changes? #5

Closed javier-godoy closed 3 years ago

javier-godoy commented 3 years ago

The style type addresses changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). We need to clarify (through an example) that changes to the application "styles" (Cascading Style Sheets_) and visual content are not style commits.

https://github.com/conventional-commits/conventionalcommits.org/issues/240 seems to suggest refactor or chore (when the visual change is by itself neither a feat nor a fix). However, we are defining refactor as "a code change" (thus replacing a PNG would not be covered under this type).

chore: Maintenance changes not covered by other types. refactor: A code change that neither fixes a bug nor adds a feature feat: A new feature (correlates with MINOR in semantic versioning) fix: A bug fix (correlates with PATCH in semantic versioning)

mlopezFC commented 3 years ago

Totally, we need to clarify that. IMHO I think it's clear which of those options to choose, here are some examples (based on style changes):

javier-godoy commented 3 years ago

Will provide clarification through examples. Feel free to reopen if you consider that we need to rewrite other parts of the document.