Skip to content

Commit d4180a0

Browse files
authored
Update README.md
1 parent 022f3a6 commit d4180a0

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Codeowners
2-
Codeowners is a CLI tool written in Rust that can generate Github's `CODEOWNERS` file. It's a re-implementation of an existing [tool](https://github.com/rubyatscale/code_ownership).
2+
The 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.
34

4-
Codeowners assumes certain conventions around Ruby/Javascript packages. These can probably be abstracted away to be language agnostic but are currently not.
5-
6-
The sole purpose of this tool existing is speed. `CODEOWNERS` generation happens as part of our git commit hooks and has 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)
5+
`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)
76

87
```
98
A CLI to validate and generate Github's CODEOWNERS file

0 commit comments

Comments
 (0)