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

Create up-to-date contributing guide with dev environment setup #16

Open
JamieDanielson opened this issue Jul 29, 2024 · 24 comments
Open

Comments

@JamieDanielson
Copy link
Member

Every repo should have a clear and working CONTRIBUTING guide that outlines how to set up a dev environment for devs to build, test, etc locally.

@JamieDanielson JamieDanielson changed the title Require updated dev environment setup Create up-to-date contributing guide with dev environment setup Jul 29, 2024
@svrnm
Copy link
Member

svrnm commented Jul 30, 2024

How would our SIG help with that? Would we go to SIGs, review their current guides and help them to write one, or would we create a template and share it with them and leave it to the SIGs to make it better?

@maryliag
Copy link

maryliag commented Aug 2, 2024

We would need to be careful with the template, because it can vary a lot by SIG/Language.
So maybe a very basic Template, but then going to all SIGs to bring this topic and make sure someone is assigned to it (could be one member of our SIG in case they're familiar with OR a member of that particular SIG).

This is more about bringing this to the SIGs who haven't thought about this at all and that is a hurdle for new contributors who have issues just to be able to start contributing and can feel discourage if they are not even able to start.

We have a lot of docs on how to use otel, but nothing on how to develop for it.

@maryliag maryliag self-assigned this Aug 2, 2024
@svrnm svrnm self-assigned this Aug 12, 2024
@kaylareopelle
Copy link
Contributor

I'm happy to help out on this one too. 🙂 I'm not able to assign myself to an issue.

@maryliag
Copy link

@kaylareopelle I added you 😄

@svrnm
Copy link
Member

svrnm commented Sep 4, 2024

Happpy to get started here! I promised a list of good examples, but the list I had was more focused around other parts (reporting issues, running tests, etc) and less about the setup of the project.

@maryliag
Copy link

maryliag commented Sep 4, 2024

np! I will work on something and share here, so people can add comments/feedback on it

@maryliag
Copy link

maryliag commented Sep 9, 2024

Update: this issue is currently being submitted as a project on Outreachy, which hopefully will help us find a new contributor that we can work with, and document their journey. This will help us create a template to be used.
The next cohort for the 2024 Outreachy will start in December, so until then we're keeping this task on Blocked. In case we can find an intern, we will move this back to in progress and find someone to collaborate with us in another way.

@RichardChukwu
Copy link

RichardChukwu commented Oct 1, 2024

Hi @maryliag I'm a December cohort outreachy applicant interested in contributing to this project. My background being a first time contributor to OpenTelemetry fits right into this and I look forward to starting if given the opportunity.

@Arogbonlo
Copy link

Arogbonlo commented Oct 2, 2024

Hello @maryliag , I'm Isaac Bayo; I just got accepted into the contribution phase and I can't wait to get started contributing to the OpenTelemetry project. Thank you

@playeast
Copy link

playeast commented Oct 2, 2024

Hello @maryliag I am outreachy applicant and im interested in the contribution on the project. I would be a first time contribution to OpenTelementery.

@Thatchidinma
Copy link

HI @maryliag applicant I am an outreachy applicant and a first time contributor to OpenTelemetry. I would love to contribute to this project.

@OmarAmeen01
Copy link

HI @maryliag applicant I am an outreachy applicant. I would love to contribute to this project.

@Blessing-Mba
Copy link

Blessing-Mba commented Oct 2, 2024

Hello @maryliag , My name is Blessing Mba, an Outreachy applicant and a first time OpenTelemetry contributor and I am interested in contributing to the setup guide for development of OpenTelemetry, this project resonates with my interests and I am eager to contribute !

@olabodeIdowu
Copy link

Hello @maryliag , my name is Olabode Idowu. I just got accepted into the contribution phase as an outreachy applicant. Considering my skills in some languages listed on the project documentation, I will love to contribute to the OpenTelemetry project and abide by its rules and guidelines. Thank you.

@Nooraw
Copy link

Nooraw commented Oct 2, 2024

Hello @maryliag. My name is Nurah Wakili and I am an Outreachy applicant interested in contributing to this issue as it aligns with my skillset. I would be happy to collaborate on creating a standard template/guidelines for the required repositories. Thank you.

@maryliag
Copy link

maryliag commented Oct 2, 2024

Hello everyone joining here because of Outreachy!
If you haven't done so, please join the CNCF slack here: https://communityinviter.com/apps/cloud-native/cncf
And then join the channel #otel-setup-mentorship-outreachy-december-2024, where we're sharing information and next steps! It's also an easier way for you to ask questions!

Welcome to the project!

@webbunivAdmin
Copy link

Hello @maryliag am Daniel Marvin, an outreachy applicant willing to contribute to this issue and the project at large
Thank you

@Dolapo-Mosuro
Copy link

HI @maryliag, I am also an Outreachy applicant and a first-time contributor to OpenTelemetry. I joined the Slack group as directed but felt I should still comment anyways.

@vickova
Copy link

vickova commented Oct 3, 2024

Hello @maryLiang, I am an outreachy applicant willing to contribute to OpenTelementery. I have also joined the slack community as directed.

@crocmons
Copy link

crocmons commented Oct 4, 2024

Hello @maryliag , My name is Ilma Salsabil, an Outreachy applicant and a first time OpenTelemetry contributor and I am interested in contributing to the setup guide for development of OpenTelemetry, this project resonates with my interests and I am eager to contribute !

@solonkonora
Copy link

HI everyone, I am an Outreachy applicant and a first-time contributor to OpenTelemetry. I i have joined the Slack group as instructed.

@Adebolaoyiye
Copy link

Hello @maryliag , My name is Adebola, an Outreachy applicant and a first time OpenTelemetry contributor and I am interested in contributing to the setup guide for development of OpenTelemetry.

@KenEkanem
Copy link

Hi @maryliag, I'm Kennedy Ekanem, an Outreachy applicant and new to contributing to OpenTelemetry. I'm eager to help with the setup guide for OpenTelemetry development!

@jedidia-nku
Copy link

Hello @maryliag, my name is Jedidia Nkunzumwami. I am an Outreachy applicant and a first-time contributor to OpenTelemetry. I apologize for the delay due to unforeseen circumstances, but I am eager to contribute to the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests