Skip to content

Commit 384b4fb

Browse files
cclaussCopilotpriya-sundaram-dev
authored
Skill: New pull request for TheAlgorithms/Python (#15212)
* Skill: New pull request for TheAlgorithms/Python @priya-sundaram-dev, please review and suggest any changes. We want to make sure that the keeper does not close new PRs as invalid. * updating DIRECTORY.md * Update pull request instructions in SKILL.md Clarified instructions for creating a new pull request and emphasized the importance of branch naming. * Clarify Markdown checkbox requirement for PRs Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Skill: fix uv.lock wording; add DIRECTORY.md/README.md auto-gen note (#15216) - Clarify that uv.lock is regenerated by the uv-lock pre-commit hook when a legitimate dependency is added; only hand-edits/reverts break the keeper. - Add a checklist item: DIRECTORY.md and README.md are bot-generated, don't hand-edit them. --------- Co-authored-by: cclauss <cclauss@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: priya-sundaram-dev <oc-409d01@agentmail.to>
1 parent 12ad81b commit 384b4fb

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Skill: New pull request for TheAlgorithms/Python
2+
3+
Create a new pull request using the rules already written in
4+
[`CONTRIBUTING.md`](../../../CONTRIBUTING.md). The goal is that creating a new
5+
pull request (human or AI) can run the same way every time, and that produces a
6+
clear, kind, tested, type-hinted, mergeable contribution.
7+
8+
## How to run this skill
9+
10+
Make sure that the local `master` branch is synced with `upstream/master` before
11+
creating a new pull request.
12+
13+
Create a new clearly named branch for the pull request. Pull request changes must
14+
not be made or submitted on the `master` branch.
15+
16+
Never hand-edit or revert the `uv.lock` file. If you add a legitimate
17+
dependency, let the `uv-lock` pre-commit hook regenerate it — do not touch it by
18+
hand. A hand-modified `uv.lock` makes the `algorithms-keeper` bot close the pull
19+
request as invalid, and even a repo maintainer cannot undo that.
20+
21+
Always check at least one Markdown checkbox in the pull request description (the "Describe your change" section), or the
22+
`algorithms-keeper` bot will close the pull request as invalid. Any repo maintainer can undo this if you @mention them on the closed pull request.
23+
24+
### 1. Before contributing / Is this an algorithm?
25+
26+
- [ ] The change adds, fixes, or documents **one algorithm** — not multiple, and
27+
not both code and doctest changes in the same PR.
28+
- [ ] It is a genuine algorithm or data structure (see the *What is an Algorithm?*
29+
section), not a script, snippet, how-to-use for an existing API, or exercise
30+
dump.
31+
- [ ] It is **not already in the repository** (search the existing directories).
32+
- [ ] **No earlier open PR** already does the same thing — link it if one exists.
33+
- [ ] Properly attributed — no plagiarism; prior sources credited.
34+
35+
### 2. Coding Style
36+
37+
- [ ] `from __future__ import annotations` is not needed because this repo only uses
38+
the latest version of CPython.
39+
- [ ] File and directory names are lowercase, use underscores, and land inside an
40+
existing directory.
41+
- [ ] Public functions/classes have **type hints**.
42+
- [ ] Public functions have **doctests that actually pass**.
43+
- [ ] Descriptive variable and function names (no single letters where a word helps).
44+
- [ ] Code is formatted and lint-clean (`ruff`, `pre-commit`).
45+
- [ ] `DIRECTORY.md` and `README.md` are **not hand-edited** — the
46+
`algorithms-keeper` bot regenerates them automatically after merge.
47+
48+
### 3. Other Requirements for Submissions
49+
50+
- [ ] At least one **Wikipedia (or equivalent) URL** documenting the algorithm.
51+
- [ ] Docstring explains what the function does and its parameters/returns.
52+
- [ ] No unnecessary third-party dependencies.

DIRECTORY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,9 @@
669669
* Forecasting
670670
* [Run](machine_learning/forecasting/run.py)
671671
* [Frequent Pattern Growth](machine_learning/frequent_pattern_growth.py)
672+
* [Gaussian Naive Bayes](machine_learning/gaussian_naive_bayes.py)
672673
* [Gradient Boosting Classifier](machine_learning/gradient_boosting_classifier.py)
674+
* [Gradient Boosting Regressor](machine_learning/gradient_boosting_regressor.py)
673675
* [Gradient Descent](machine_learning/gradient_descent.py)
674676
* [K Means Clust](machine_learning/k_means_clust.py)
675677
* [K Nearest Neighbours](machine_learning/k_nearest_neighbours.py)
@@ -685,6 +687,8 @@
685687
* [Multilayer Perceptron Classifier](machine_learning/multilayer_perceptron_classifier.py)
686688
* [Polynomial Regression](machine_learning/polynomial_regression.py)
687689
* [Principle Component Analysis](machine_learning/principle_component_analysis.py)
690+
* [Random Forest Classifier](machine_learning/random_forest_classifier.py)
691+
* [Random Forest Regressor](machine_learning/random_forest_regressor.py)
688692
* [Scoring Functions](machine_learning/scoring_functions.py)
689693
* [Self Organizing Map](machine_learning/self_organizing_map.py)
690694
* [Sequential Minimum Optimization](machine_learning/sequential_minimum_optimization.py)
@@ -923,6 +927,7 @@
923927
* [Back Propagation Neural Network](neural_network/back_propagation_neural_network.py)
924928
* [Convolution Neural Network](neural_network/convolution_neural_network.py)
925929
* [Input Data](neural_network/input_data.py)
930+
* [Perceptron](neural_network/perceptron.py)
926931
* [Simple Neural Network](neural_network/simple_neural_network.py)
927932
* [Two Hidden Layers Neural Network](neural_network/two_hidden_layers_neural_network.py)
928933

@@ -975,6 +980,7 @@
975980
* [Lorentz Transformation Four Vector](physics/lorentz_transformation_four_vector.py)
976981
* [Malus Law](physics/malus_law.py)
977982
* [Mass Energy Equivalence](physics/mass_energy_equivalence.py)
983+
* [Maxwells Equations](physics/maxwells_equations.py)
978984
* [Mirror Formulae](physics/mirror_formulae.py)
979985
* [N Body Simulation](physics/n_body_simulation.py)
980986
* [Newtons Law Of Gravitation](physics/newtons_law_of_gravitation.py)

0 commit comments

Comments
 (0)