Skip to content

Comer/remote ruleset config #30

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

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
26f302b
Added remote ruleset logic
Aug 3, 2021
5947155
Added unit tests for remote rule sets
Aug 3, 2021
920fa68
Refactored method name for stylecheck - func isValidUrl should be isV…
Aug 3, 2021
85fe4cf
Refactored method name for stylecheck - func isValidUrl should be isV…
Aug 3, 2021
77d2108
Fixed linting warnings and removed usage of http.get
Aug 3, 2021
91a3885
Removed whitespace and linting warnings
Aug 3, 2021
5d4f398
Refactored code to use newrequestwithcontext
Aug 3, 2021
f6fb076
MAdding more error handling in response text
Aug 4, 2021
0e14eed
Adding additional edge cases for isValidURL
Aug 4, 2021
b64f5f5
Updated README to include documentation on adding remote rulesets
Aug 4, 2021
865618f
Removed TODO comment
Aug 4, 2021
58ece7e
Merge branch 'main' into comer/remote-ruleset-config
Aug 5, 2021
cef7e1b
Adding downloadedRules.yaml to woke ignore
mkcomer Aug 5, 2021
46af11d
Removed DownloadFile functionality and updated remote config to marsh…
Aug 10, 2021
2103fd5
Removed downloadedfile from wokeignore as downloadfile functionality …
Aug 10, 2021
d2c4185
Updated get remote config logic and updated unit tests
Aug 11, 2021
43cb02e
Merge branch 'main' into comer/remote-ruleset-config
mkcomer Aug 12, 2021
11ba44c
docs: autogenerated update for docs/snippets/woke.md: `7eb51d`
github-actions[bot] Sep 29, 2021
9231c98
Merge branch 'get-woke:main' into main
mkcomer Oct 7, 2021
4b1a979
Merge branch 'main' into comer/remote-ruleset-config
Oct 7, 2021
4c82011
Updated request with context to resolve lint error. added tests
Oct 7, 2021
99366dc
Added readme, remove woke binary and coverage report
Oct 8, 2021
09ec3e0
removed space
Oct 8, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added readme, remove woke binary and coverage report
  • Loading branch information
MK Comer committed Oct 8, 2021
commit 99366dc40f64d2ad833a829d64426ab23e20181f
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<p align="center">
<a href="https://github.com/get-woke/woke">
<img alt="woke logo" src="https://raw.githubusercontent.com/get-woke/woke/main/assets/default-monochrome.svg" height="80" />
</a>
<h3 align="center">
Detect non-inclusive language in your source code.
</h3>
<p align="center"><em>I stay woke - Erykah Badu</em></p>
</p>

---
<br />

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/get-woke/woke?logo=github&sort=semver)](https://github.com/get-woke/woke/releases)
![GitHub All Releases](https://img.shields.io/github/downloads/get-woke/woke/total)
[![Build](https://github.com/get-woke/woke/workflows/Build/badge.svg?branch=main)](https://github.com/get-woke/woke/actions)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/get-woke/woke)](https://goreportcard.com/report/github.com/get-woke/woke)
[![codecov](https://codecov.io/gh/get-woke/woke/branch/main/graph/badge.svg?token=BP133BM3HP)](https://codecov.io/gh/get-woke/woke/branch/main)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/get-woke/woke)](https://pkg.go.dev/github.com/get-woke/woke)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/get-woke/woke)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fget-woke%2Fwoke.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fget-woke%2Fwoke?ref=badge_shield)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](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.

![woke.gif](https://raw.githubusercontent.com/get-woke/get-woke.github.io/main/img/woke.gif)

## 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 <https://docs.getwoke.tech>.

## 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.

![GitHub contributors](https://img.shields.io/github/contributors/get-woke/woke)

## 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).

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fget-woke%2Fwoke.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fget-woke%2Fwoke?ref=badge_large)
2 changes: 1 addition & 1 deletion docs/snippets/woke.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ woke [globs ...] [flags]
--stdin Read from stdin
```

###### Auto generated by spf13/cobra on 29-Sep-2021
###### Auto generated by spf13/cobra on 13-Aug-2021
57 changes: 0 additions & 57 deletions pkg/config/coverage.out

This file was deleted.

Binary file removed woke
Binary file not shown.