docs(README): Missing required parameter issue_number

junglesub commented 4 months ago

Resolves #2635

Before the change?

Upon reviewing the README for the octokit.js library, I encountered an example in the webhooks section related to the issues.createComment method, but found that it was missing the required parameter issue_number, leading to confusion during implementation.

After the change?

After suggesting the addition of the issue_number parameter to the example in the README for the issues.createComment method, clarity and usability of the documentation would be enhanced.

Pull request checklist

N/A

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

[ ] Yes
[x] No

github-actions[bot] commented 4 months ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

github-actions[bot] commented 3 months ago

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

The release is available on:

Your semantic-release bot :package::rocket:

octokit / octokit.js