Skip to content

docs(hacktober): record require_type_hints.sh run (15 PRs closed) + script recommendations - #15168

Merged
cclauss merged 1 commit into
TheAlgorithms:masterfrom
priya-sundaram-dev:hacktober-tracker-require-type-hints
Sep 2, 2026
Merged

docs(hacktober): record require_type_hints.sh run (15 PRs closed) + script recommendations#15168
cclauss merged 1 commit into
TheAlgorithms:masterfrom
priya-sundaram-dev:hacktober-tracker-require-type-hints

Conversation

@priya-sundaram-dev

Copy link
Copy Markdown
Contributor

Follow-up to #15159, as requested in #15081 (comment).

@cclauss ran scripts/close_pull_requests_with_require_type_hints.sh at ~20:44 UTC, which closed 15 PRs (all carried the require type hints label). This PR records that run in docs/hacktober_2026_prep.md.

What changed

(Verified each of the 15 is state=closed, merged=false with the closing comment "Closing require_type_hints PRs to prepare for Hacktoberfest".)

Recommendations for the scripts/close_pull_requests_with_*.sh jobs

The five scripts are byte-for-byte identical except for one label name and one comment string. A few suggestions:

  1. Correctness — the --limit 500 cap silently skips PRs. There are ~918 open PRs, but gh pr list ... --limit 500 returns at most 500, so any matching PR past the 500th is never closed. Filter server-side with --label "<label>" (and, if needed, --search) instead of pulling everything and matching in jq; that removes the cap for the labels that matter and is much faster.
  2. De-duplicate into one parameterized script. e.g. close_pull_requests_with_label.sh "require type hints" deriving the comment from the label. Five copies drift: awaiting_changes/failing_tests have sleep 2, require_tests has it commented out, and require_type_hints/require_descriptive_names have none — a single source avoids that.
  3. Consistent, deliberate throttling. Standardise on one sleep (or gh's built-in retry) so bulk closes don't trip secondary rate limits.
  4. Safety rails. set -euo pipefail, an explicit --repo TheAlgorithms/Python, and a DRY_RUN=1 mode that prints what would close before a maintainer commits to it.
  5. Machine-readable summary. Emit the list of closed PR numbers (and a final count) to stdout/a file so this tracker can be updated from the script output rather than by hand.

Happy to send these as a follow-up PR if you'd like — I kept this one docs-only so it stays easy to review.

Checklist

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one file (documentation); no algorithm added.
  • All new Python files are placed inside an existing directory. (n/a — docs only)
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions. (n/a — docs only)
  • All function parameters and return values are annotated with Python type hints. (n/a — docs only)
  • All functions have doctests that pass the automated testing. (n/a — docs only)
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation. (n/a — docs only)
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: related to priya-sundaram-dev as a maintainer? #15081.

@algorithms-keeper algorithms-keeper Bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Sep 2, 2026
@algorithms-keeper algorithms-keeper Bot removed the awaiting reviews This PR is ready to be reviewed label Sep 2, 2026
@cclauss
cclauss merged commit dc7d5eb into TheAlgorithms:master Sep 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This PR modified documentation files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants