openllmetry icon indicating copy to clipboard operation
openllmetry copied to clipboard

šŸš€ Feature: General contributing guide is missing

Open ankur0904 opened this issue 1 year ago • 4 comments

Which component is this feature for?

Anthropic Instrumentation

šŸ”– Feature description

This feature will explain how to contribute and outline the contribution workflow:

  1. Fork the repository
  2. Clone the repository
  3. Make local changes
  4. Pull changes to local repository
  5. Create the pull request 6. Await approval

šŸŽ¤ Why is this feature needed ?

If any new contributor wants to participate in the project, they need to understand the basic workflow for contributions, such as forking, cloning, etc. A detailed contribution guide will be more beneficial.

āœŒļø How do you aim to achieve this?

By writing the documentation.

šŸ”„ļø Additional Information

No response

šŸ‘€ Have you spent some time to check if this feature request has been raised before?

  • [X] I checked and didn't find similar issue

Are you willing to submit PR?

Yes I am willing to submit a PR!

ankur0904 avatar Oct 02 '24 03:10 ankur0904

Sounds good @ankur0904! This should be in https://github.com/traceloop/docs

nirga avatar Oct 02 '24 04:10 nirga

@nirga Thanks for the feedback. I will soon submit the PR.

ankur0904 avatar Oct 02 '24 04:10 ankur0904

@nirga @ankur0904

I have submitted the pull request where I updated the CONTRIBUTING.md file. I hope it gets merged soon, but I’m open to any feedback or changes that may be required.

Thank you!

AkashJana18 avatar Oct 02 '24 07:10 AkashJana18

@AkashJana18 @nirga It's nice that you have submitted the PR. But please make sure to give everyone a chance, I was also working on it and about to submit the PR. As I mentioned in the issue as well as in comment.

ankur0904 avatar Oct 02 '24 08:10 ankur0904