Skip to content

Commit d89075f

Browse files
authored
Update README.md
1 parent 651caa6 commit d89075f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Codeowners
2-
The [oxidation](https://wiki.mozilla.org/Oxidation) of an [existing CLI](https://github.com/rubyatscale/code_ownership) written in Ruby.
3-
This tool generates Github's `CODEOWNERS` file, assuming certain conventions around Ruby/Javascript packages.
2+
This is a CLI tool to generate Github's `CODEOWNERS` file from an existing project assuming certain conventions around file annotations and Ruby/Javascript packages.
3+
It's also the [oxidation](https://wiki.mozilla.org/Oxidation) of an existing [CLI tool](https://github.com/rubyatscale/code_ownership) written in Ruby.
44

55
`CODEOWNERS` generation happens as part of our git commit hooks and on Gusto's main repo takes ~18s to run. The Rust implementation which is a drop in replacement cuts that down to <= 2s. (Tested on a Mackbook M1)
66

7-
```
7+
### Documentation
8+
```bash
89
A CLI to validate and generate Github's CODEOWNERS file
910
1011
Usage: codeowners [OPTIONS] <COMMAND>
1112
1213
Commands:
1314
generate Generate the CODEOWNERS file and save it to '--codeowners-file-path'
1415
validate Validate the validity of the CODEOWNERS file. A validation failure will exit with a failure code and a detailed output of the validation errors
15-
generate-and-validate Chains both 'generate' and 'verify' commands
16+
generate-and-validate Chains both 'generate' and 'validate' commands
1617
help Print this message or the help of the given subcommand(s)
1718
1819
Options:

0 commit comments

Comments
 (0)