search

gadicc / node-yahoo-finance2

Unofficial API for Yahoo Finance
https://www.npmjs.com/package/yahoo-finance2
MIT License
353 stars 58 forks source link

feat(module): Add new fundamentals time series module #748

Closed Shadaeiou closed 3 months ago

Shadaeiou commented 3 months ago

Closes #745

Changes

Type

Comments/notes

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 97.77778% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 93.41%. Comparing base (7a1d03b) to head (9842b94). Report is 2 commits behind head on devel.

Files Patch % Lines
src/modules/fundamentalsTimeSeries.ts 97.77% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #748 +/- ## ========================================== + Coverage 93.12% 93.41% +0.29% ========================================== Files 26 27 +1 Lines 669 714 +45 Branches 226 240 +14 ========================================== + Hits 623 667 +44 - Misses 46 47 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

gadicc commented 3 months ago

Wow :open_mouth: You, Sir, are a legend! :bow:

  1. It's your first contribution to the project
  2. It's an entirely new module
  3. It's a perfect submission in terms of style, docs, tests, etc.

Thanks so much! This is great! And so well timed. :pray: :pray:

gadicc commented 3 months ago

This will be in the next release, and there'll be an automated message here when that happens.

Thanks once again. How was your first contribution? Is there anything we can make clearer anywhere?

gadicc commented 3 months ago

:tada: This PR is included in version 2.10.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

Shadaeiou commented 3 months ago

This will be in the next release, and there'll be an automated message here when that happens.

Thanks once again. How was your first contribution? Is there anything we can make clearer anywhere?

Hey, no problems! I've been using this library for a long time so it was nice to dig in and see how it works! I figured what I've written is probably a good start and can be iterated on, I just really wanted the data and was sad when I saw that they must have changed the API!

The actual code was easy to write because I had so many good examples to reference. As for the actual contributing documentation, well considering that I've used little very little Typescript and very little yarn, it was actually very easy! I missed formatting and coverage at first and that was definitely user error, which was eventually caught by CI and I was able to easily correct.

Thanks for all your hard work and kudos for such a well written library! I'll definitely keep my eyes open for more ways I can contribute!