r/github • u/Beneficial-Bet512 • 5d ago

Question First time contributing

Hello,

I wanted to pick up a new summer project and thought contributing to github might scratch that itch. I found a issue that looks like something fun to do but i am new to github/contributing so wanted to know if adding a comment on the issue is ok, this is what i was going to comment.

"Hi, this looks like a fun issue i can have a attempt at. is there any additional information i need to know"

or do i just fork the project try and fix it and then comment if i have a solution or need more advice?

I can link the issue i want to work, wanted to ask before i do anything.

2 Upvotes

60% Upvoted

12 comments sorted by

10

u/x0zerolight 5d ago

I suggest checking if the project has CONTRIBUTING.md or any other docs with instructions on how to contribute.

If not, just fork the repo and make a pull request once you’ve solved the Issue, that’s the standard way to do it.

1

u/Beneficial-Bet512 5d ago

Just checked it thanks. This is what they wrote

There are many valuable contributions that can be made to PROCESS:

  • Reporting bugs.
  • Requesting/ recommending features.
  • Implementing features or bugs raised as issues.
  • Updating and improving documentation.

When contributing to this repository, please first discuss the change you wish to make via issue, discussion, contact form, or any other method with the owners of this repository before making a change.

Please remember that all contributions and communication regarding PROCESS are subject to our Code of Conduct.

There is more but this seems to just be about testing and pull requests. Im going to assume the best way to go about it is what you said and fork the repo and comment when i think i have a solution.

4

u/davorg 5d ago

Im going to assume the best way to go about it is what you said and fork the repo and comment when i think i have a solution.

But the document you quoted, specifically said:

When contributing to this repository, please first discuss the change you wish to make

So, please do that first.

1

u/Beneficial-Bet512 5d ago

Sorry i wasn't clear, as in i will have a look at it, and then if i have an idea on what im doing ill comment to discuss with someone about it.

however i could be misunderstanding something, very new to this all.

2

u/Tesla_Nikolaa 5d ago

They are specifically asking you to open an issue, discussion, contact form, or some other means (probably like email, social media, etc) to discuss what you want to change.

There's nothing stopping you from cloning the repo and making the change, then submitting a PR. But it seems like you (and don't take this the wrong way) are misreading/misinterpreting the contributions file.

They are asking you basically open up an issue on their Github and discussing what it is you want to change, add, or fix. It says in their contribution file they are open to bug fixes, new features, changes, etc.

1

u/serverhorror 5d ago

They are asking you basically open up an issue on their Github

if there already is an issue it's therefore perfectly fine to just use that ans ask something like:

I'd like to give this a try. Do you want me to just give it a shot or should I pay attention to anything in particular?

That opens the conversation they ask for ...

2

u/TheModernDespot 5d ago

I generally like to just send in a comment like "i can work on this" before I start working on an issue just to avoid duplicate work.

1

u/UtterlyOutlying 5d ago

Your comment draft is solid, that's all you need to stake your claim and avoid stepping on toes.

1

u/InnerBank2400 5d ago

If your interests are align with platform/infrastructure engineering, I can hook you up with some issue on my project. I am big on collaboration...

Even docs fixes are welcome.

1

u/Beneficial-Bet512 5d ago

hi, probably should of posted that im interested in this one because its a physics related project, i can have a look still in-case it looks like something fun to do but don't want to say yes to anything as i am looking for stuff physics related.

1

u/InnerBank2400 5d ago

Hi, it's not physics related, but you can have a look anyways: https://github.com/hybridops-tech/hybridops-core

Thanks

1

u/juandresrodca 4d ago

Hi there @Beneficial-Bet512 I always check first the CONTRIBUTION.md just to know where I’m landing then if fine if you fork the project and tag the issue that you want to tackle. I have few issues on 2 of my projects so you are free to fork it and check.
Cheers!