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

Add a "How to Contribute" section to opentelemetry.io #3254

Closed
avillela opened this issue Sep 11, 2023 · 2 comments · Fixed by #3651
Closed

Add a "How to Contribute" section to opentelemetry.io #3254

avillela opened this issue Sep 11, 2023 · 2 comments · Fixed by #3651
Labels
discussion Input from everyone is helpful to drive this forward end-user space For all issues related to the end-user space in the Community site enhancement New feature or request sig:enduser

Comments

@avillela
Copy link
Contributor

avillela commented Sep 11, 2023

Desired feature or idea: There's a lot of information in the OTel repos explaining how to contribute to different areas of OpenTelemetry; however, we don't have a centralized location to document this. Adding a "contributing" tab off of opentelemetry.io could serve as a "one stop shop" for folks who want to know of the different ways in which they can contribute to the project.

Additional context: After speaking with @svrnm, he suggested that I create a blog post on the OTel blog based on this Medium article that I published recently, as a stop-gap, until we can put together a such a page.

@svrnm
Copy link
Member

svrnm commented Sep 12, 2023

Not sure if there should be a dedicated "Contributing" tab, or if this should live under "Community", as we have a simple version of that already there: https://opentelemetry.io/community/#develop-and-contribute, but I overall agree that it would be great to have that "one stop shop"

I think there are a few things we need to distinguish:

  • The "rules" to contribute, which are contained in the CONTRIBUTING.md of each project, by rules I mean things like "use npm this and that way" or "your commits should have this and that structure"
  • The "formal" set of things how you can be part of the community, which live at https://github.com/open-telemetry/community/
  • Some "informal" recommendations (like your blog post), on how to get started with contributing, especially aimed towards new comers

I think we can add the most value by enriching the website with more of the "informal" stuff where we provide people with some soft suggestions on how they can get started. So that would be the point for me to begin with.

As an additional reference, I'll leave https://www.kubernetes.dev/ here, as "[t]his site is the home of contributor documentation, and serves as a starting point for your journey as a Kubernetes contributor."

@svrnm svrnm added enhancement New feature or request discussion Input from everyone is helpful to drive this forward sig:enduser end-user space For all issues related to the end-user space in the Community site labels Sep 12, 2023
@chalin
Copy link
Contributor

chalin commented Oct 16, 2023

Hi all. Not sure if you consider this a duplicate or simply a related issue of the following issues, but I wanted to mention and cross-link them since this topic isn't new:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Input from everyone is helpful to drive this forward end-user space For all issues related to the end-user space in the Community site enhancement New feature or request sig:enduser
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants