Chore: Update README with list of known issues

[soda0289]

This commit updates the README with a list of known issues with ESLint rules and plugins.

@JamesHenry I think by providing a list of known issues with this parser we can help new users get started and cut back on duplicate issues. I don't mind when people open issues on failing rules or plugins as it helps determine the work needed to make the parser fully support eslint. Do you think this is a worth while change or might be better served by documentation?

@corbinu @mattdell @flying-sheep Did I miss any known issues with this parser and eslint?

[eslintbot]

Thanks for the pull request, @soda0289! I took a look to make sure it's ready for merging and found some changes are needed:

• Pull requests with code require an issue to be mentioned at the end of the commit summary, such as (fixes #1234). Please update the commit summary with an issue (file a new issue if one doesn't already exist).

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

[aladdin-add]

can we add known issues to ISSUE_TEMPLATE.md?

[soda0289]

@aladdin-add We probably should. Not sure if a link to the README would be sufficient. Or if we should add more documentation with common work arounds too.

[JamesHenry]

Is this referring to function overloads?

[soda0289]

Yes function overloading. I can change the name to be more clear.

I'm going to write up an issue for this problem. I think we might be able to come up with a better solution than the one I have proposed.

[soda0289]

#253 Summarizes the current situation and the three PR's I created to fix this issue.

[JamesHenry]

Yes please just update that Multiple function declarations point so it is clear that it is referring to function overloads, then we can merge this

[eslintbot]

Thanks for the pull request, @soda0289! I took a look to make sure it's ready for merging and found some changes are needed:

• Pull requests with code require an issue to be mentioned at the end of the commit summary, such as (fixes #1234). Please update the commit summary with an issue (file a new issue if one doesn't already exist).

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)