Removed condescending language from docs #2143
Conversation
|
|
There was a problem hiding this comment.
@carolstran This is aligned with the tone we want to have in our documentation moving forward. Thanks for taking the time to do this. 👍
We have a textlint dictionary to catch some of this language.
I wonder if adding just or simple or other examples to that list would be helpful. Sometimes they catch too wide a range of uses, so I can't use them, but it's smart enough to make suggestions when it works. These are some examples of replacements we have in there now.
// Words and phrases
["\\(s\\)he", "they"],
["he or she", "they"],
["he/she", "they"],
["crazy", "complex"],
["crazier", "more complex"],
["craziest", "most complex"],
["dumb", "unintended"],
["insane", "outrageous"],
// Words we would like to not use altogether
["simply", ""],
Just some thoughts - not necessary for this PR.
|
Thank you @jennifer-shehane! For the linting, I thought about adding that to this PR, but most of the words I fixed came with exceptions so didn't remove all instances entirely. Not sure if the linter is blocking or rather a suggestion though. And while I have you here, I actually have another (off topic) question. I'm a new open source maintainer and I'm curious about the CLA step to your process. Why did you all decide to add that? |
|
@carolstran That decision came down from legal - mostly for use in our actual product's repo - all of our code for the product is open source https://github.com/cypress-io/cypress Then we extended the CLA requirement to our other OS projects. I don't know much about why that decision was made. We decided to use cla-assistant to implement it though. |
|
@jennifer-shehane That's super helpful, thank you for the additional context - I really appreciate you sharing 😊 |
Closes #2120
As discussed in the issue, this PR attempts to remove as many instances of condescending or isolating language (ie. simple, easy, just, etc) as possible in the documentation.
Disclaimer: I may have ruined some of your marketing text 😂 so feel free to revert. If even a fraction of these changes can be merged then it will be a huge step towards making the documentation more inclusive!