Skip to content

Commit 7757ffc

Browse files
Added installation instructions and clarified usage (#19)
* added installation instructions and clarified that maintainers looks for OWNERS files in the current directory * At MadhavJivrajani's suggestion, I reworded the Usage section to be more generic about when maintainers uses the current directory as the context vs. using a flag to set the context for the file, directory, repo, etc. * At MadhavJivrajani's suggestion, this contains a small rewording of the usage sectionw.
1 parent 37c05ce commit 7757ffc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ https://k8s.devstats.cncf.io/d/13/developer-activity-counts-by-repository-group?
55

66
and print the github id, pr comment count and devstats contribution count as well.
77

8+
## Installation
9+
10+
Run `make` to install `maintainers`. Currently `make` will run the `hack/install-maintainers.sh` script.
11+
12+
## Usage
13+
14+
Unless there is a flag to specify the context (e.g., --repository-github, --yaml-file,
15+
--kubernetes-directory), the tool uses the directory in which it is run to provide the context
16+
for the results.
17+
818
```bash
919
[dims@dims-m1 20:58] ~/go/src/k8s.io/kubernetes ⟩ ../maintainers/maintainers help prune
1020
Remove stale github ids from OWNERS and OWNERS_ALIASES

0 commit comments

Comments
 (0)