adding inclusive language standards to the README #2446
Conversation
This PR accompanies #2425, which adds inclusive language standards as a checkstyle rule.
README.md
Outdated
| @@ -254,6 +254,32 @@ in `.baseline/copyright/*.txt`. The largest file (sorted lexicographically) will | |||
|
|
|||
| To automatically update all files with mismatching/missing copyrights, run `./gradlew format`. | |||
|
|
|||
| ### Inclusive Language | |||
There was a problem hiding this comment.
Thoughts on moving this to fit into https://github.com/palantir/gradle-baseline/tree/develop/docs/best-practices/java-coding-guidelines
It's not java-specific, but otherwise I think that's a reasonable place for guidelines to live (where this won't describe a specific check, but rather our guidance which will future checks may enforce)
There was a problem hiding this comment.
A new file in that directory that isn't specific to java could also work nicely, though a bit harder for folks to discover. I defer to your judgement :-]
There was a problem hiding this comment.
good idea! moved them to a new file in that directory and linked from the best practices readme.
There was a problem hiding this comment.
i'll update the top-level readme with information about the checkstyle enforcement in that PR.
lsingh123
changed the title
For now, this PR simply adds our inclusive standards as a best practice. In the future, we will enforce these standards as a checkstyle rule.
DEI and Legal have approved this.