traceloop / traceloop/openllmetry
🚀 Feature: General contributing guide is missing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.4k
- Forks
- 1.1k
- Avg merge
- 8d 14h
- Merged PRs (30d)
- 2
Description
Which component is this feature for?
Anthropic Instrumentation
🔖 Feature description
This feature will explain how to contribute and outline the contribution workflow:
- Fork the repository
- Clone the repository
- Make local changes
- Pull changes to local repository
- 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?
- I checked and didn't find similar issue
Are you willing to submit PR?
Yes I am willing to submit a PR!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No target file or test is named. Start by locating the repository's existing contribution documentation and README, then add a general guide covering forking, cloning, local changes, syncing, opening a pull request, and awaiting approval. Done means newcomers can follow the documented workflow from start to finish.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100