Skip to content

Commit 570fb06

Browse files
authored
Add CONTRIBUTING.md (#2555)
1 parent a0ea0e1 commit 570fb06

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
Welcome to OpenTelemetry community repository!
4+
5+
Before you start - see OpenTelemetry general [contributing](guides/contributor/README.md)
6+
requirements and recommendations.
7+
8+
## Updating SIG information on the README.md
9+
10+
The SIG tables on the [README.md](README.md) page are generated from [`sigs.yml`](sigs.yml).
11+
12+
To regenerate those tables after updating any `sigs.yml` content, run:
13+
14+
```bash
15+
make table-generation
16+
```
17+
18+
## Updating the assets.md page
19+
20+
The [`assets.md`](assets.md) page has an auto-generated table of contents.
21+
To regenerate the table of contents after updating any headings on that page, run:
22+
23+
```bash
24+
make markdown-toc
25+
```

0 commit comments

Comments
 (0)