search

whatwg / meta

Discussions and issues without a logical home
Creative Commons Zero v1.0 Universal
93 stars 161 forks source link

Category for non-normative changes #189

Open annevk opened 3 years ago

annevk commented 3 years ago

We have "Meta:" and "Editorial:", but if someone makes a clarifying edit (e.g., https://github.com/whatwg/encoding/pull/230) or adds an example, it might still be useful to have a prefix for others to know they can probably skip it.

Should we use "Non-normative:"? We use that in a number of places already.

sideshowbarker commented 3 years ago

I think a "Non-normative: " prefix is fine — but it seems worth considering that if there are some views of the commit descriptions which limit them to the first 50 characters, a prefix that takes up 16 characters leaves a lot fewer characters to use for the actual commit description. But maybe that’s not a real concern in practice these days.

annevk commented 3 years ago

We're okay with 72 characters per https://github.com/whatwg/meta/blob/master/COMMITTING.md. I wouldn't mind a shorter prefix though.

domenic commented 3 years ago

I don't have a strong opinion here, and can try to use anything people prefer. My weak opinion is that things are fine as-is; examples like the one given are not something I'd want to skip over.

andreubotella commented 3 years ago

"Clarify:" might work for clarifications, but not for examples. "Non-normative:" would be good enough, but I often struggle keeping my commit messages to 72 characters.

not-my-profile commented 9 months ago

I think it would indeed be very good to consistently categorize normative vs non-normative changes. However I also agree that the prefix shouldn't be too long.

How about: