Update README.md

[AkshayJangid]

by going through the documentation , it is no where hinted that we need to place Types declaration in separate file. Thus explicitly mentioning it in readme.

Updated Readme file to explicitly mention about adding Types declaration in separate file.

Description

By going through the documentation it is not very clear about adding this in separata file. This leads to error Cannot read properties of undefined on the leaf elements.

Related Issue

Motivation and Context

I was stuck because of this for 4 hours.

How Has This Been Tested?

Not required.

Types of changes

• [x ] Updated docs / Refactor code / Added a tests case (non-breaking change)
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• [ ] My code follows the code style of this project.
• [x] My change requires a change to the documentation.
• [x ] I have updated the documentation accordingly.
• [ ] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [ ] All new and existing tests passed.
• [ ] I have updated the changelog.

[Jameskmonger]

Hi @AkshayJangid , thanks for the submission - I don't think this is intended behaviour but it would be good to document it while it's still present. I'm just catching up on #1455. It might be good to link to this issue in the README, as my understanding is that this is a bug and should be fixed.

[AkshayJangid]

Hey @Jameskmonger , the problem is at least 4 people i know were stuck because of this for a day. Hence just trying to add it temporarily.

[Jameskmonger]

@AkshayJangid I completely agree. Please adjust the PR to have:

bug: PLEASE MAKE SURE TO PLACE THIS TYPES DECLARATION IN A SEPARATE FILE. (see bug #1455)

then I will merge it immediately. Ty

[Jameskmonger]

Looks like I can edit your PR 😄 I will merge now, ty for contrib @AkshayJangid

[codecov-commenter]

Codecov Report

Merging #1546 (ba0da86) into master (05a9237) will not change coverage. The diff coverage is n/a.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

@@           Coverage Diff           @@
##           master    #1546   +/-   ##
=======================================
  Coverage   99.48%   99.48%           
=======================================
  Files          53       53           
  Lines        1370     1370           
  Branches      200      200           
=======================================
  Hits         1363     1363           
  Partials        7        7           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more