Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REQUEST: Improve new contributor guide #2404

Open
zacharyrgonzales opened this issue Oct 22, 2024 · 2 comments
Open

REQUEST: Improve new contributor guide #2404

zacharyrgonzales opened this issue Oct 22, 2024 · 2 comments
Labels
area/contributor-guide Issues or PRs related to contributor guide

Comments

@zacharyrgonzales
Copy link
Contributor

zacharyrgonzales commented Oct 22, 2024

Affected Repository

https://github.com/open-telemetry/community

Requested changes

  • I want to make the new contributor guide easier to find

    • Move contributor guide link to towards the top of the README.md
    • Add prominent "Start Contributing" button in docs navigation
  • Add instructions to find pick an open issue with the "good first issue" label

    • Include direct links to "good first issue" label searches
    • Add step-by-step tutorial for finding beginner-friendly issues
    • Include screenshots of GitHub issue filters
  • Add a table with all the repositories and what they mean

    • core: Central OpenTelemetry APIs and SDK implementations
    • Instrumentation: Auto-instrumentation libraries for various languages/frameworks
    • Collector: Data collection agent for receiving, processing and exporting telemetry
    • Operator: Kubernetes operator for managing OpenTelemetry components
    • Specifications: OpenTelemetry technical specifications and protocols
    • Documentation: Central documentation repository and website

Purpose

To improve the new contributor experience by making it easier to find contribution opportunities and understand the OpenTelemetry project structure. This will help reduce barriers to entry and increase the number of active contributors.

Expected Duration

2-3 weeks. This includes time for implementing changes, getting community feedback, and iterating on the documentation structure.

Repository Maintainers

@svrnm

@zacharyrgonzales zacharyrgonzales added the area/repo-maintenance Maintenance of repos in the open-telemetry org label Oct 22, 2024
@svrnm svrnm added area/contributor-guide Issues or PRs related to contributor guide and removed area/repo-maintenance Maintenance of repos in the open-telemetry org labels Oct 22, 2024
@svrnm
Copy link
Member

svrnm commented Oct 22, 2024

Hey @zacharyrgonzales, thanks for your feedback yesterday and for raising this issue!

Move contributor guide link to towards the top of the README.md

That's a good idea. The "Get Involved" section at the top of the Readme could profit from that link

Add prominent "Start Contributing" button in docs navigation

That's a separate discussion for an issue over at https://github.com/open-telemetry/opentelemetry.io

Add instructions to find pick an open issue with the "good first issue" label

There are some details to that in processes.md but they indeed need some more details. Adding links and a tutorial would be helpful!

Add a table with all the repositories and what they mean

I also think that will be helpful. We need to keep in mind that some repositories are not within that scope or for different purposes (e.g. the .github repository), but we still can list them. If we create such a list we also need to consider that new repositories have to be added there (that needs to be added to this guide


@zacharyrgonzales if you'd like to help with that I recommend to go through that list one by one. So you tackle one item, we work on the PR and then we address the next one. wdyt?

@zacharyrgonzales
Copy link
Contributor Author

@svrnm That sounds like a great plan! Lets do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributor-guide Issues or PRs related to contributor guide
Projects
Status: No status
Development

No branches or pull requests

2 participants