Skip to content

Add a README.md file to the scripts directory #13480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2025
Merged

Add a README.md file to the scripts directory #13480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
beb5c8f
Add a README.md file to the scripts directory
cclauss Oct 14, 2025
82256d8
updating DIRECTORY.md
cclauss Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions DIRECTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@
* [Permutations](data_structures/arrays/permutations.py)
* [Prefix Sum](data_structures/arrays/prefix_sum.py)
* [Product Sum](data_structures/arrays/product_sum.py)
* [Rotate Array](data_structures/arrays/rotate_array.py)
* [Sparse Table](data_structures/arrays/sparse_table.py)
* [Sudoku Solver](data_structures/arrays/sudoku_solver.py)
* Binary Tree
Expand Down
27 changes: 27 additions & 0 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Dealing with the onslaught of Hacktoberfest
* https://hacktoberfest.com

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.

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.

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.

* close_pull_requests_with_require_descriptive_names.sh
* close_pull_requests_with_require_tests.sh
* close_pull_requests_with_require_type_hints.sh
* close_pull_requests_with_failing_tests.sh
* close_pull_requests_with_awaiting_changes.sh
* find_git_conflicts.sh

### Run on 14 Oct 2025: 107 of 541 (19.77%) pull requests closed.

Script run | Open pull requests | Pull requests closed
--- | --- | ---
None | 541 | 0
require_descriptive_names | 515 | 26
require_tests | 498 | 17
require_type_hints | 496 | 2
failing_tests | 438 | ___58___
awaiting_changes | 434 | 4
git_conflicts | [ broken ] | 0