Add CONTRIBUTING.md (#2555)

open-telemetry · Feb 10, 2025 · 570fb06 · 570fb06
1 parent a0ea0e1
commit 570fb06
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Contributing
+
+Welcome to OpenTelemetry community repository!
+
+Before you start - see OpenTelemetry general [contributing](guides/contributor/README.md)
+requirements and recommendations.
+
+## Updating SIG information on the README.md
+
+The SIG tables on the [README.md](README.md) page are generated from [`sigs.yml`](sigs.yml).
+
+To regenerate those tables after updating any `sigs.yml` content, run:
+
+```bash
+make table-generation
+```
+
+## Updating the assets.md page
+
+The [`assets.md`](assets.md) page has an auto-generated table of contents.
+To regenerate the table of contents after updating any headings on that page, run:
+
+```bash
+make markdown-toc
+```