Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use alex to ensure we're using inclusive language #469

Merged
merged 1 commit into from
Mar 8, 2022
Merged

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Mar 8, 2022

🧰 Changes

This PR brings alex into our docs build process to ensure we're using inclusive language in our writing. This now is included in our pretest script and will fail CI if there is any potentially insensitive/inconsiderate language in this repo's Markdown files.

In terms of config, it's pretty light:

  • I tweaked the profanitySureness setting ever-so-slightly (it was flagging the words "execute" and "period" as profanity, for example)
  • Ignored CHANGELOG.md since that's auto-generated
  • Ignored a few words that were flagged as profane in our code of conduct since the usage is intentional

When I finally get around to adding shared community files for our org, we should definitely include this.

🧬 QA & Testing

Do the language tweaks make sense? And is the build process setup sound?

@kanadgupta kanadgupta added enhancement New feature or request documentation Improvements or additions to documentation labels Mar 8, 2022
@kanadgupta kanadgupta added this to the v7 milestone Mar 8, 2022
Comment on lines +22 to +28
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
<!-- alex ignore just -->
- Focusing on what is best not just for us as individuals, but for the
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of these changes were automatically done by my VSCode formatter 😬 sorry

@kanadgupta kanadgupta changed the title docs: use alex to ensure we're using inclusive language docs: use alex to ensure we're using inclusive language Mar 8, 2022
@kanadgupta kanadgupta requested a review from erunion March 8, 2022 01:32
Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome. Curious what all it'd find on docs.readme.com

.eslintignore Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants