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

Community-driven rule list #67

Closed
johnbent opened this issue Apr 19, 2021 · 3 comments
Closed

Community-driven rule list #67

johnbent opened this issue Apr 19, 2021 · 3 comments
Labels
enhancement New feature or request

Comments

@johnbent
Copy link

Is your feature request related to a problem? Please describe.
We are looking for a single tool to scan our code for problematic language. There are at least three types of problematic language that I think can be scanned:

  1. Non inclusive terms
    a. Awesome. Seems like woke is perfect for this.
    b. Corporations should be able to share this effort both to maintain the evolving word list and suggested replacements as well as the scanning tools.
  2. Corporate terms
    a. Like the name of unannounced products that developers might be thinking about but shouldn't mention in comments
    b. Seems like woke is perfect for this since we can pass exact word lists to it
  3. Vulgarity and slurs
    a. Developers shouldn't but sometimes they put swear words in their comments
    b. I would hope it never happens but you could imagine people potentially putting slurs into their comments as well
    c. I suppose we could handle vulgarity and slurs like we handle corporate terms but this seems much better as a community initiative

Describe the solution you'd like
A maintained word list for vulgarity and slurs.

Describe alternatives you've considered
We could do it ourselves but we want to share this with the community and have confidence that we are using appropriate word lists.

Additional context
It seems like a fair number of folks are building similar word lists. INI, inclusivelint. We should share a word list I think.

@johnbent johnbent added the enhancement New feature or request label Apr 19, 2021
@caitlinelfring
Copy link
Member

I've been considering a feature for woke that would allow inclusion of multiple "lists" that would allow you to "extend" your ruleset without including them by default. They could be included in woke, or maintained by the community on GitHub/remotely. Something along the lines of

extends:
  - default
  - https://github.com/get-woke/rulesets.git/vulgarity.yaml
  - file:///home/me/myruleset.yaml

I came across https://github.com/hashicorp/go-getter the other day which would be interesting to use, but I haven't had the chance to dig into it much. This would give the ability for the community to maintain lists without forcing rules on all users. Thanks for bringing this up!

@johnbent
Copy link
Author

johnbent commented May 5, 2021

https://github.com/retextjs/retext-equality/tree/main/data/en is by far the largest word lists I've found publicly maintained.

@caitlinelfring
Copy link
Member

Closing in favor of #104

@caitlinelfring caitlinelfring changed the title Vulgarity not included? Community-driven rule list Aug 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants