Skip to content

Commit c16a0cf

Browse files
committed
Document contributor recipes
1 parent c6f820a commit c16a0cf

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

tools/make/lib/contributors/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,40 @@ This directory contains [`make`][make] recipes for managing the project contribu
1212

1313
<!-- /.intro -->
1414

15+
<!-- Usage documentation. -->
16+
17+
<section class="usage">
18+
19+
## Usage
20+
21+
```text
22+
Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
23+
```
24+
25+
### Commands
26+
27+
#### list-contributors
28+
29+
Lists contributors to the project repository.
30+
31+
```bash
32+
$ make list-contributors
33+
```
34+
35+
#### update-contributors
36+
37+
Updates the project `CONTRIBUTORS` file.
38+
39+
<!-- run-disable -->
40+
41+
```bash
42+
$ make update-contributors
43+
```
44+
45+
</section>
46+
47+
<!-- /.usage -->
48+
1549
<!-- Section to include notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
1650

1751
<section class="notes">

0 commit comments

Comments
 (0)