diff --git a/CODE_COMMENT_STYLE.md b/CODE_COMMENT_STYLE.md index 28f90de815f..acb137a6893 100644 --- a/CODE_COMMENT_STYLE.md +++ b/CODE_COMMENT_STYLE.md @@ -99,7 +99,7 @@ A comment is generally used for: - Open the file (Wrong) - Use "this" instead of "the" to refer to the current thing. - + - Gets the toolkit for this component (Recommended) - Gets the toolkit for the component (Not recommended) @@ -107,6 +107,16 @@ A comment is generally used for: - Opens the `log` file +### Taboos in comments + +The Code Comment Style defined in this document follows the [CNCF Code of Conduct](https://github.com/tikv/tikv/blob/master/CODE_COMMENT_STYLE.md). The following language uses are deemed as taboos and are not acceptable in code comments: + +- Sexualized language +- Racial or political allusions +- Public or private harassment +- Language that contains private information, such as a physical or electronic address, without explicit permission +- Other inapproiate uses + ### Tips for a good comment - Comment code while writing it.