Update Welcome a first-time contributor example #257
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks @calkeo! Were you able to test these changes in a workflow? |
joshmgross
reviewed
Apr 15, 2022
| return // Creator is already a contributor. | ||
| } | ||
| if (issues.length) { | ||
| return |
There was a problem hiding this comment.
Should we keep the comment here?
Suggested change
| return | |
| return // Creator is already a contributor. |
There was a problem hiding this comment.
Perhaps this format is better.
Suggested change
| return | |
| // Creator is already a contributor. | |
| return |
|
👋 Going to close this out, feel free to reopen if you'd like to pick this back up. There's still a pending question: #257 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the pagination logic for the "Welcome a first-time contributor" example in the README.
The current example retrieves all issues created by the given user. This means that if there's a PR that passes
issue.number !== context.issue.number && issue.pull_requeston the first page of results, the logic will still retrieve data for all remaining pages. This can add quite a lot of overhead on repositories where the given user has authored many issues.This PR stops the pagination early by calling the
done()method if a match is found.I appreciate that the current example may be deliberate for the purpose of keeping the example simple and easily-readable, but I thought I'd open this up just in case.