search

kubernetes / contributor-site

Code for kubernetes.dev
https://www.kubernetes.dev
Apache License 2.0
66 stars 148 forks source link

Add an entry to the Community section under the Glossary for contributor's terms #401

Closed mrgiles closed 1 year ago

mrgiles commented 1 year ago

Example term used in comments for Issues and PRs: nit

Q: What does the term nit mean in the context of a comment to an issue or a PR?

A: nit is short for "nitpick", not sure where the shortening comes from originally. nit on a PR has some more specific connotation: it's like nit-picking in a good-spirited way, they're not trying to badger you or belittle the PR and acknowledge that the criticism is small. Usually nit comments are not considered necessary to fix before merging, they're a non-blocking suggestion to make a small correction.

(Credit: @BenTheElder)

There could be other terms that need further explanation for new community members such as myself, but this one stood out.

It seems likely that this should go somewhere under the Community tag under docs/reference/glossary (thank you @parispittman for the suggestion) but I'm not exactly sure where, I need some guidance to figure it out. Once I have that information, I'll go ahead and create a PR to add it.

Thanks.

FYI @sftim

mrgiles commented 1 year ago

/assign

mrgiles commented 1 year ago

Closing this as it belongs to the Community repo instead