Skip to content

Commit

Permalink
Modify rule S7036: Update rule description (#4322)
Browse files Browse the repository at this point in the history
  • Loading branch information
GabinL21 authored Sep 25, 2024
1 parent 8ae6c27 commit 9492c8a
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions rules/S7036/text/rule.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@ Clean code should not make use of offensive language but instead use neutral and

Code is meant to be understandable and clear to the reader.
Discriminatory and offensive language is often used for expressiveness.
Such language has made its way into technical jargon and code despite being derived
from specific cultural contexts that carry discriminatory connotations.
These terms do not accurately convey the intended meaning in technical contexts
and are often idiomatic expressions that can be confusing or misleading.
Using such terms can perpetuate negative biases and hinder effective communication.

For instance, the term `sanity check` is not meaningful in a software context as the term
sane relates to mental health, which is irrelevant to code functionality.
More precise and descriptive alternatives, such as validation check or verification check,
exist and provide a clearer meaning. By choosing unambiguous and neutral terminology,
we promote inclusivity and improve the clarity and maintainability of code.

Companies with a mandate for inclusivity need to build products for everyone with
the following considerations:

* *Brand reputation*
** The adoption of respectful language in code aligns with evolving industry standards to
position a brand as a leader in innovation and professionalism and avoid reputational damage and backlash.

* *Employee Relations*
** Respectful and inclusive language in code reflects a respectful and inclusive workplace culture.
** Clear language in code fosters better understanding and communication among team members.

* *Legal/Regulatory Compliance*
** Compliance with legal requirements and industry regulations
** Neutral and inclusive terminology minimizes the risk of litigation
Such language has made its way into technical jargon
and code despite being derived from specific cultural contexts that carry discriminatory connotations.
These terms are often idiomatic expressions that can be misleading
and using such terms can perpetuate negative biases and hinder effective communication.

For instance, the term sanity check is derived from psychiatric sanity,
which can have a negative connotation with respect to a person’s mental health.
Code itself cannot be in a state of sanity or, conversely, insanity.
In the context of code, more precise and descriptive alternatives,
such as validation check or verification check, exist and provide a clearer meaning.
By choosing unambiguous and neutral terminology, we promote inclusivity and reduce the ambiguity of code.

Companies with a mandate for inclusivity need to build products for everyone with the following considerations:

* *Brand reputation*:
** The adoption of respectful language in code aligns with evolving industry standards to position a brand as a leader in innovation and professionalism and avoid reputational damage and backlash.
** Example: https://www.technologyreview.com/2019/04/05/1175/facebook-algorithm-discriminates-ai-bias/[Facebook’s ad-serving algorithm discriminates by gender and race | MIT Technology Review]

* *Employee Relations*:
** Respectful and inclusive language in code reflects a respectful and inclusive workplace culture.
** Clear language in code fosters better understanding and communication among team members.

* *Legal/Regulatory Compliance*:
** Compliance with legal requirements and industry regulations.
** Neutral and inclusive terminology minimizes the risk of litigation.
** Example: https://accessibility.blog.gov.uk/2022/12/09/some-changes-to-the-public-sector-digital-accessibility-regulations/[Some changes to the public sector digital accessibility regulations]

== How to fix it

Expand Down

0 comments on commit 9492c8a

Please sign in to comment.