Skip to content

Commit 5e148bb

Browse files
Fix GitHub capitalization, link to docs about CODEOWNERS (#17)
Just a pet peeve 😅 Also, link to docs about codeowners
1 parent fb51e5b commit 5e148bb

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Codeowners
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.
2+
This is a CLI tool to generate [GitHub `CODEOWNERS` files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) from an existing project assuming certain conventions around file annotations and Ruby/Javascript packages.
33
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)

0 commit comments

Comments
 (0)