Google

README

Google

NOTE: This project is neither maintained nor endorsed by Google.

This repository contains a Vale-compatible implementation of the Google Developer Documentation Style Guide (CC BY 4.0).

Getting Started

To get started, add the package to your configuration file (as shown below) and then run vale sync.

StylesPath = styles
MinAlertLevel = suggestion

Packages = Google

[*]
BasedOnStyles = Vale, Google

See Packages for more information.

Repository Structure

/Google

The YAML-based rule implementations that make up our style.

/fixtures

The individual unit tests. Each directory should be named after a rule found in /Google and include its own .vale.ini file that isolates its target rule.

/testdata

The expected Vale output for each fixture directory, one <Rule>.ct file per fixture. We use go-cmdtest to run Vale against each fixture and compare its output. Run the suite with go test ./...; regenerate the expectations after an intentional change with go test ./... -update.

/coverage

How much of the style guide we implement, tracked topic by topic. Each key is a subtopic set to true or false, optionally followed by a comment naming the rules that implement it. Run go test -v -run TestCoverage ./... to print the current figures; the same test fails if a named rule no longer exists, so a topic can't silently claim coverage it has lost.