diff --git a/scripts/01-intro.md b/scripts/01-intro.md new file mode 100644 index 0000000..ef504ed --- /dev/null +++ b/scripts/01-intro.md @@ -0,0 +1,138 @@ +# OpenTelemetry New Contributor Walkthrough — Draft Video Script + +**Target length:** 4–6 minutes +**Audience:** Someone interested in contributing to OpenTelemetry but unsure where to begin. + +## 1. Welcome — Starting at OpenTelemetry.io (~30 sec) + +**On screen:** Open `opentelemetry.io`. + +**Narration:** + +Welcome! If you're interested in contributing to OpenTelemetry but aren't sure where to start, this video will walk you through the main community resources. + +We'll start from the OpenTelemetry website and find our way to the contributor documentation, GitHub community, Special Interest Groups, CNCF Slack, and finally how to find issues you can use to make your first contribution. + +You don't need to already be an OpenTelemetry expert to get involved. Plenty of contributors start with documentation fixes or issue triage. + +--- + +## 2. Finding the Contribution Guide (~45 sec) + +**On screen:** Navigate from `opentelemetry.io` to the community/contribution resources and open the contributor documentation. + +**Narration:** + +From the OpenTelemetry website, navigate to the community and contribution resources. That takes you to the OpenTelemetry community repository on GitHub. + +Start with the New Contributor Guide. + +Before contributing code, you'll want to review a few prerequisites, including creating a GitHub account, signing the Contributor License Agreement, and reading the Code of Conduct. + +The contributor guide also explains how the community works and where to find more detailed contribution instructions. + +--- + +## 3. Finding the OpenTelemetry GitHub Community (~45 sec) + +**On screen:** Open the `open-telemetry/community` repository. Scroll through the README and highlight **Get Involved**. + +**Narration:** + +This is the OpenTelemetry community repository. It's where the project keeps its governance docs, its Special Interest Groups list, and its meeting calendar. + +The "Get Involved" section lists three next steps: + +First, read the contributor guide. + +Second, join Slack and community meetings. + +And third, if you already know which part of OpenTelemetry interests you, find its Special Interest Group, or SIG. + +Almost everything in the project is organized by SIG, so that's next. + +--- + +## 4. What Is a SIG? (~60 sec) + +**On screen:** Navigate to the OpenTelemetry SIG list in `community/sigs.md`. Scroll through several SIGs and show the columns for meetings, Slack channels, and repositories. + +**Narration:** + +SIG stands for **Special Interest Group**. + +OpenTelemetry is a large project, so the community is organized into SIGs focused on different parts of the project. + +There are SIGs for specific implementations and languages, as well as cross-cutting areas such as security, documentation, contributor experience, and developer experience. + +For each group, the SIG list gives you the meeting schedule, meeting notes, Slack channel, repositories, and who to contact. + +SIG meetings are open to anyone, so sitting in on a meeting or its Slack channel lets you see what a group is working on before you pick something up. + +Choose the SIG that most closely matches the area where you'd like to contribute. + +--- + +## 5. Joining Slack (~60 sec) + +**On screen:** Return to the community README → Slack section. Show the CNCF Slack signup link and the listed OpenTelemetry channels. + +**Narration:** + +OpenTelemetry doesn't run its own Slack workspace. It uses the **CNCF** Slack — the Cloud Native Computing Foundation's shared workspace. + +If you aren't already a member, follow the signup link from the OpenTelemetry community page to create your CNCF Slack account. + +Once you're there, start in `#opentelemetry-new-contributors`. It's the channel set up specifically for people making their first contribution. There's also a general `#opentelemetry` channel. + +Most SIGs have their own Slack channel as well. You can find the appropriate channel directly from the SIG list we looked at earlier. + +These channels are where you can ask questions and reach the people maintaining the area you're interested in. + +--- + +## 6. Finding a Good First Issue (~60 sec) + +**On screen:** Open an OpenTelemetry Collector Contrib GitHub repository. Go to **Issues** and filter by the `good first issue` label. Then open the repository's `CONTRIBUTING.md`. + +**Narration:** + +Once you've picked an area, open its repository and go to the **Issues** tab. + +Many repositories tag beginner-friendly work with the `good first issue` label. Filter the issue list by that label to see what's open. + +Not every repository uses the label, and the ones that do can run out of tagged issues. If the filtered list is empty, ask in the SIG's Slack channel — someone there will know what needs picking up. + +Most repositories also have a `CONTRIBUTING.md`. That's where the guidelines live: how to set up the project locally, how the review process works, and anything specific to that codebase. Read it before you start, since the process differs between repositories. + +Also read the issue discussion and check whether someone is already working on it. + +If it looks unclaimed, leave a comment saying you'd like to take it. That tells maintainers and other contributors the issue is being picked up, and it's the right place to ask a clarifying question — the answer stays attached to the issue for whoever reads it next. + +If you don't get a reply, or you're not sure the issue is a good fit for a first contribution, ask in the SIG's Slack channel. + +--- + +## 7. Wrap-Up (~30 sec) + +**On screen:** Briefly revisit the community repository or show a simple path: + +`opentelemetry.io → Contributor Guide → SIG → Slack → GitHub Issue` + +**Narration:** + +That's the basic path for getting started: + +Start at OpenTelemetry.io. + +Read the contributor guide. + +Find a SIG related to your interests. + +Join the CNCF Slack community and the relevant SIG channel. + +Then find a good first issue and connect with the community before you start working on it. + +And remember: contributing doesn't only mean writing code. Documentation, issue triage, community work, pull request reviews, and other contributions all help OpenTelemetry grow. + +Welcome to the OpenTelemetry community. We hope to see you contributing.