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

Enhance README: Shields to capture the attention of potential contributors #1344

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

devactivity-team
Copy link
Contributor

I noticed you have opened issues labeled help wanted. I recommend enhancing the README to make the call for new contributors more prominent.

Changes Made:

  1. Shields: Added Shields.io badges at the top of the README

GitHub repo Good Issues for newbies GitHub Help Wanted issues GitHub Help Wanted PRs GitHub repo Issues

[![GitHub repo Good Issues for newbies](https://img.shields.io/github/issues/open-telemetry/opentelemetry-php/good%20first%20issue?style=flat&logo=github&logoColor=green&label=Good%20First%20issues)](https://github.com/open-telemetry/opentelemetry-php/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) [![GitHub Help Wanted issues](https://img.shields.io/github/issues/open-telemetry/opentelemetry-php/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20issues)](https://github.com/open-telemetry/opentelemetry-php/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub Help Wanted PRs](https://img.shields.io/github/issues-pr/open-telemetry/opentelemetry-php/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20PRs)](https://github.com/open-telemetry/opentelemetry-php/pulls?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub repo Issues](https://img.shields.io/github/issues/open-telemetry/opentelemetry-php?style=flat&logo=github&logoColor=red&label=Issues)](https://github.com/open-telemetry/opentelemetry-php/issues?q=is%3Aopen)

Why This Matters:

  • Attract New Contributors: Considering there is a number of opened issues labeled 'Help Wanted' - a welcoming and appealing README is one of the most efficient ways to attract new contributors

Additional Resources:

For more insights into building a strong open-source community, check out the Building Community guide.

🚀 Thank you for considering this pull request! 🚀

@devactivity-team devactivity-team requested a review from a team July 7, 2024 14:30
Copy link

welcome bot commented Jul 7, 2024

Thanks for opening your first pull request! If you haven't yet signed our Contributor License Agreement (CLA), then please do so that we can accept your contribution. A link should appear shortly in this PR if you have not already signed one.

Copy link

linux-foundation-easycla bot commented Jul 7, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: devactivity-team / name: Oleg (b492b07)

Copy link
Contributor

@ChrisLightfootWild ChrisLightfootWild left a comment

Choose a reason for hiding this comment

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

Seems like a good idea to me!

@ChrisLightfootWild ChrisLightfootWild requested a review from a team July 7, 2024 18:13
@brettmc
Copy link
Collaborator

brettmc commented Jul 9, 2024

Hi @devactivity-team very happy to accept this PR thanks. We do need to have the CLA signed (see the bot comment above) before we can accept any contributions.
thanks :)

Copy link

codecov bot commented Jul 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.65%. Comparing base (17ad56a) to head (b492b07).
Report is 23 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #1344      +/-   ##
============================================
+ Coverage     74.61%   74.65%   +0.04%     
  Complexity     2504     2504              
============================================
  Files           355      355              
  Lines          7180     7180              
============================================
+ Hits           5357     5360       +3     
+ Misses         1823     1820       -3     
Flag Coverage Δ
8.1 74.38% <ø> (+0.06%) ⬆️
8.2 74.55% <ø> (+0.04%) ⬆️
8.3 74.49% <ø> (-0.03%) ⬇️
8.4 ?

Flags with carried forward coverage won't be shown. Click here to find out more.

see 5 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 17ad56a...b492b07. Read the comment docs.

@brettmc
Copy link
Collaborator

brettmc commented Sep 25, 2024

Hi @devactivity-team are you able to sign the CLA so that we can merge this? thanks :)

@devactivity-team
Copy link
Contributor Author

Hi @devactivity-team are you able to sign the CLA so that we can merge this? thanks :)

Apologies for the delay. Done

@bobstrecansky bobstrecansky merged commit 20bf3cf into open-telemetry:main Sep 25, 2024
10 checks passed
@brettmc
Copy link
Collaborator

brettmc commented Sep 25, 2024

Thanks, it looks great! :)

brettmc pushed a commit to brettmc/opentelemetry-php that referenced this pull request Oct 2, 2024
bobstrecansky pushed a commit that referenced this pull request Oct 2, 2024
* 8.4: fixing some implicit nullable params

* fix withspan handler nullable + example (#1377)

- class is nullable for pre hooks
- add phpt tests for withspan and its interaction with auto root span

* fix: update references to logging exporter (#1383)

This exporter has been replaced by the debug exporter and will be removed soon. Related to open-telemetry/opentelemetry-collector#11037

Signed-off-by: Alex Boten <[email protected]>

* fix: Update collector tag in example to latest (#1384)

Follow-up from #1383. Debug exporter isn't available until v0.86.0, so this new configuration throws an error when trying to run the collector. `Error: cannot unmarshal the configuration: unknown exporters type "debug" for "debug"` Instead of setting to v0.86.0, I noticed the other docker files omitted the tag (so latest is pulled). I just updated this to match.

* Remove `MeterInterface::isEnabled()` and fix meter config re-enabling (#1387)

* Update SPI dependency to v1. (#1388)

* Fix README badges. (#1389)

* add phpDocumentor instructions to Makefile (#1385)

* add phpDocumentor instructions to Makefile

Signed-off-by: svrnm <[email protected]>

* update DEVELOPMENT.md

Signed-off-by: svrnm <[email protected]>

---------

Signed-off-by: svrnm <[email protected]>

* Update README.md (#1344)

* Fix `IncompatibleReturnValueException` in `MessageFactoryTest` (#1392)

PSR7 `RequestInterface::getUri()` must return `UriInterface`, not `string`; explicit typehint was added in `2.0`.

* more implicit nulls

---------

Signed-off-by: Alex Boten <[email protected]>
Signed-off-by: svrnm <[email protected]>
Co-authored-by: Alex Boten <[email protected]>
Co-authored-by: Jamie Danielson <[email protected]>
Co-authored-by: Tobias Bachert <[email protected]>
Co-authored-by: Chris Lightfoot-Wild <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Oleg <[email protected]>
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.

4 participants