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.

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

Category for non-normative changes #189

Open
annevk opened this issue Sep 21, 2020 · 5 comments
Open

Category for non-normative changes #189

annevk opened this issue Sep 21, 2020 · 5 comments

Comments

@annevk
Copy link
Member

annevk commented Sep 21, 2020

We have "Meta:" and "Editorial:", but if someone makes a clarifying edit (e.g., whatwg/encoding#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
Copy link
Contributor

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
Copy link
Member Author

annevk commented Sep 21, 2020

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
Copy link
Member

domenic commented Sep 21, 2020

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
Copy link
Member

"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
Copy link

not-my-profile commented Sep 26, 2023

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:

  • norm: for normative changes
  • info: for informative (non-normative) changes that are non-trivial (not just typo/grammar/link/style fixes)
  • edit: for editorial (non-normative) changes (e.g. typo/grammar/link/style fixes)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

5 participants