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 contributor guide #687

Closed
wants to merge 4 commits into from

Conversation

RichardChukwu
Copy link

part of open-telemetry/sig-contributor-experience#31

Changes

  • Included a Pre-requisites section containing tools, languages, and software required to work with the repository.
  • Added a Further Help section to guide contributors on where to go to seek help contributing
  • 'TBD' marks areas that required info is needed and will be helpful

This will make it clearer for first time contributors to ensure they have all they require to contribute locally without running into issues.

Please review and let me know if you have any suggestions or feedback.

Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.49%. Comparing base (9ed2ad8) to head (ec9ed24).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #687   +/-   ##
=======================================
  Coverage   52.49%   52.49%           
=======================================
  Files          57       57           
  Lines        3444     3444           
=======================================
  Hits         1808     1808           
  Misses       1466     1466           
  Partials      170      170           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RichardChukwu RichardChukwu changed the title Improve contributor guide Improve contributor guide [chore] Feb 11, 2025
@RichardChukwu RichardChukwu changed the title Improve contributor guide [chore] Improve contributor guide Feb 11, 2025
Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

Sorry, but I do not see any benefit in changes proposed in this PR apart from the nice

New contributors are welcome!

CONTRIBUTING.md Outdated Show resolved Hide resolved
New contributors are welcome!

## Pre-requisites
* Go (version required) TBD
Copy link
Member

Choose a reason for hiding this comment

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

I think it is obvious 😉

Copy link
Author

Choose a reason for hiding this comment

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

Not sure it is stated anywhere in the repo though, if its the latest version, I think it would be helpful to include it, as some versions may cause conflicts especially for first time contributors

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Author

Choose a reason for hiding this comment

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

ooh, didn't see this, I think it will be useful to add this info to the contributing guide or at least link to this file?

Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

This PR does not improve anything. It lacks details in all points.

What is more, the nice welcoming message was even removed from unknown reason: #687 (review)

I appreciate your will to contribute. However, please "do your homework" before submitting a PR.

@RichardChukwu
Copy link
Author

This PR does not improve anything. It lacks details in all points.

What is more, the nice welcoming message was even removed from unknown reason: #687 (review)

I appreciate your will to contribute. However, please "do your homework" before submitting a PR.

Duly noted @pellared I'll review accordingly and get required info before submitting a PR, I apologize for the lack of details

@pellared pellared closed this Feb 17, 2025
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.

2 participants