https://github.com/get-woke/woke
Detect non-inclusive language in your source code.
https://github.com/get-woke/woke
ci codereview conscious-language go golang inclusive inclusive-coding inclusive-language inclusive-lint inclusive-linter lint linter linting static-analysis text-analysis
Last synced: 16 days ago
JSON representation
Detect non-inclusive language in your source code.
- Host: GitHub
- URL: https://github.com/get-woke/woke
- Owner: get-woke
- License: mit
- Created: 2020-08-31T17:21:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-07T10:11:55.000Z (12 months ago)
- Last Synced: 2024-11-06T11:44:32.804Z (6 months ago)
- Topics: ci, codereview, conscious-language, go, golang, inclusive, inclusive-coding, inclusive-language, inclusive-lint, inclusive-linter, lint, linter, linting, static-analysis, text-analysis
- Language: Go
- Homepage: https://docs.getwoke.tech
- Size: 22 MB
- Stars: 453
- Watchers: 6
- Forks: 61
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- my-awesome-starred - get-woke/woke - Detect non-inclusive language in your source code. (Go)
- go-awesome - woke - Check text files for discriminatory words (Open source library / Word Processing)
- awesome-go-extra - woke - inclusive language in your source code.|342|53|15|2020-08-31T17:21:07Z|2022-08-22T18:05:25Z| (Go Tools / Other Software)
README
Detect non-inclusive language in your source code.
I stay woke - Erykah Badu
---
[](https://github.com/get-woke/woke/releases)

[](https://github.com/get-woke/woke/actions)
[](LICENSE)
[](https://goreportcard.com/report/github.com/get-woke/woke)
[](https://codecov.io/gh/get-woke/woke/branch/main)[](https://pkg.go.dev/github.com/get-woke/woke)
[](https://github.com/pre-commit/pre-commit)

[](https://app.fossa.com/projects/git%2Bgithub.com%2Fget-woke%2Fwoke?ref=badge_shield)
[](https://github.com/avelino/awesome-go#other-software)---
Creating an inclusive work environment is imperative to a healthy, supportive, and
productive culture, and an environment where everyone feels welcome and included.`woke` is a text file analysis tool that finds places within your source code that contain
non-inclusive language and suggests replacing them with more inclusive alternatives.Companies like [GitHub](https://github.com/github/renaming), [Twitter](https://twitter.com/TwitterEng/status/1278733303508418560), and [Apple](https://developer.apple.com/news/?id=1o9zxsxl) are actively supporting a move to inclusive language.

## Why is this named `woke`?
> When [I](https://github.com/caitlinelfring) started writing `woke` in August 2020, my goal was to build a
> tool that would shed light on non-inclusive language in source code and that would enable a long-term commitment to using inclusive language.
>
> `woke` is a reference to an awareness of social and political issues, especially racial prejudice and discrimination,
> and has a historic use within the African-American community.
> This tool aims to push this kind of awareness even further into the software development community.
>
> I named this project `woke` because I saw it as a tool to awaken our code to non-inclusive language.
>
> You can read more about the origins and history of the word on [Wikipedia](https://en.wikipedia.org/wiki/Woke).## Install `woke`
- [On my machine](https://docs.getwoke.tech/installation)
- [On CI/CD systems](https://docs.getwoke.tech/installation/#ci)## Documentation
Documentation is hosted at .
## Contributing
Please read [CONTRIBUTING.md](https://github.com/get-woke/woke/blob/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
[](https://github.com/get-woke/woke/graphs/contributors)
## Authors
- **Caitlin Elfring** - [caitlinelfring](https://github.com/caitlinelfring)
See also the list of [contributors](https://github.com/get-woke/woke/contributors) who have participated in this project.
## License
This application is licensed under the MIT License, you may obtain a copy of it
[here](https://github.com/get-woke/woke/blob/main/LICENSE).[](https://app.fossa.com/projects/git%2Bgithub.com%2Fget-woke%2Fwoke?ref=badge_large)