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

Improve Contributing Guide #1680

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

RichardChukwu
Copy link

This PR is part of Add Contributing guide to repos

All changes are contained in details there.

Motivation:

This PR sets the groundwork for a comprehensive guide, enabling maintainers to contribute essential details. Once complete, this document will serve as a critical resource for future contributors, following a consistent pattern across other OTel repos.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Comment on lines +109 to +110
| `Gradle build fails` | Ensure plugin versions are specified in `settings.gradle.kts`. |
| `Test failures` | Check for missing dependencies or version conflicts. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these seem pretty generic

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but I feel it will be very much helpful to a first time contributor to this repo, which is the main aim of this guide. @jaydeluca

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants