Skip to content

Commit beb5c8f

Browse files
committed
Add a README.md file to the scripts directory
1 parent 788d95b commit beb5c8f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

scripts/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Dealing with the onslaught of Hacktoberfest
2+
* https://hacktoberfest.com
3+
4+
Each year, October brings a swarm of new contributors participating in Hacktoberfest. This event has its pros and cons, but it presents a monumental workload for the few active maintainers of this repo. The maintainer workload is further impacted by a new version of CPython being released in the first week of each October.
5+
6+
To help make our algorithms more valuable to visitors, our CONTRIBUTING.md file outlines several strict requirements, such as tests, type hints, descriptive names, functions, and/or classes. Maintainers reviewing pull requests should try to encourage improvements to meet these goals, but when the workload becomes overwhelming (esp. in October), pull requests that do not meet these goals should be closed.
7+
8+
Below are a few [`gh`](https://cli.github.com) scripts that should close pull requests that do not match the definition of an acceptable algorithm as defined in CONTRIBUTING.md. I tend to run these scripts in the following order.
9+
10+
* close_pull_requests_with_require_descriptive_names.sh
11+
* close_pull_requests_with_require_tests.sh
12+
* close_pull_requests_with_require_type_hints.sh
13+
* close_pull_requests_with_failing_tests.sh
14+
* close_pull_requests_with_awaiting_changes.sh
15+
* find_git_conflicts.sh
16+
17+
### Run on 14 Oct 2025: 107 of 541 (19.77%) pull requests closed.
18+
19+
Script run | Open pull requests | Pull requests closed
20+
--- | --- | ---
21+
None | 541 | 0
22+
require_descriptive_names | 515 | 26
23+
require_tests | 498 | 17
24+
require_type_hints | 496 | 2
25+
failing_tests | 438 | ___58___
26+
awaiting_changes | 434 | 4
27+
git_conflicts | [ broken ] | 0

0 commit comments

Comments
 (0)