Skip to content

Commit

Permalink
CI Docs: Using an inclusive linter (#726)
Browse files Browse the repository at this point in the history
* Add docs about using an inclusive linter

* Address markdown lint errors

* Improve clarity

* Address PR comments

* Address PR comments

* Address PR comments and add link to inclusive linting section in main CI guidance page

* Add link to woke action with reviewdog
  • Loading branch information
jeremydelacruz authored Oct 20, 2021
1 parent 3dee6f0 commit 0faa708
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/continuous-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ An automated build should encompass the following principles:
- [ ] **Code Style Checks**
- Code across an engineering team must be formatted to agreed coding standards. Such standards keep code consistent, and most importantly easy for the team and customer(s) to read and refactor. Code styling consistency encourages collective ownership for project scrum teams and our partners.
- There are several open source code style validation tools available to choose from ([code style checks](https://github.com/checkstyle/checkstyle), [StyleCop](https://en.wikipedia.org/wiki/StyleCop)). The [Code Review section](../code-reviews/README.md#language-specific-guidance) of the playbook has suggestions for linters and preferred styles for a number of languages.
- Your code and documentation should avoid the use of non-inclusive language wherever possible. Follow the [Inclusive Linting section](inclusive-linting.md) to ensure your project promotes an inclusive work environment for both the team and for customers.
- We recommend incorporating security analysis tools within the build stage of your pipeline such as: code credential scanner, security risk detection, static analysis, etc. For Azure DevOPS, you can add a security scan task to your pipeline by installing the [Microsoft Security Code Analysis Extension](https://secdevtools.azurewebsites.net/#pills-onboard). GitHub Actions supports a similar extension with the [RIPS security scan solution](https://github.com/marketplace/actions/rips-security-scan).
- Code standards are maintained within a single configuration file. There should be a step in your build pipeline that asserts code in the latest commit conforms to the known style definition.
- [ ] **Build Script Target**
Expand Down
69 changes: 69 additions & 0 deletions docs/continuous-integration/inclusive-linting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Inclusive Linting

As software professionals we should strive to promote an inclusive work environment, which naturally extends to the code and documentation we write. It's important to keep the use of inclusive language consistent across an entire project or repository.

To achieve this, we recommend using a text file analysis tool such as an inclusive linter and including this as a step in your CI pipelines.

## What to Lint for

The primary goal of an inclusive linter is to flag any occurrences of non-inclusive language within source code (and optionally suggest some alternatives). Non-inclusive words or phrases in a project can be found anywhere from comments and documentation to variable names.

An inclusive linter may include its own dictionary of "default" non-inclusive words and phrases to run against as a good starting point. These tools can also be customizable, oftentimes offering the ability to omit some terms and/or add your own.

The ability to add additional terms to your linter has the added benefit of enabling linting of sensitive language on top of inclusive linting. This can prevent things such as customer names or other non-public information from making it into your git history, for instance.

## Getting Started with an Inclusive Linter

### [`woke`]

One inclusive linter we recommend is `woke`. It is a language-agnostic CLI tool that detects non-inclusive language in your source code and recommends alternatives. While `woke` automatically applies a [default ruleset] with non-inclusive terms to lint for, you can also apply a custom rule config (via a yaml file) with additional terms to lint for. See [`example.yaml`] for an example of adding custom rules.

Running the tool locally on a file or directory is relatively straightforward:

```sh
$ woke test.txt

test.txt:2:2-6: `guys` may be insensitive, use `folks`, `people` instead (warning)
* guys
^
```

`woke` can be run locally on your machine or CI/CD system via CLI and is also available as a two GitHub Actions:

- [Run woke]
- [Run woke with Reviewdog]

To use the standard "Run woke" GitHub Action with the default ruleset in a CI pipeline:

1. Add the `woke` action as a step in your project's CI pipeline yaml:

```yaml
name: ci
on:
- pull_request
jobs:
woke:
name: woke
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2

- name: woke
uses: get-woke/woke-action@v0
with:
# Cause the check to fail on any broke rules
fail-on-error: true
```
1. Run your pipeline
1. View the output in the "Actions" tab in the main repository view
For more information about additional configuration and usage, see the official [docs].
[`woke`]: https://github.com/get-woke/woke
[default ruleset]: https://github.com/get-woke/woke/blob/main/pkg/rule/default.yaml
[`example.yaml`]: https://github.com/get-woke/woke/blob/main/example.yaml
[Run woke]: https://github.com/marketplace/actions/run-woke
[Run woke with reviewdog]: https://github.com/marketplace/actions/run-woke-with-reviewdog
[docs]: https://docs.getwoke.tech/

0 comments on commit 0faa708

Please sign in to comment.