Skip to content

Commit 375a6a0

Browse files
authored
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.
1 parent 12ad81b commit 375a6a0

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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` and
11+
then create a new branch for the pull request. Pull request changes must not
12+
be on the `master` branch.
13+
14+
Never modify the `uv.lock` file because the `algorithms-keeper` bot will close
15+
the pull request as invalid. Even a repo maintainer cannot undo this.
16+
17+
Always have one checked Markdown checkbox in the pull request commit body, or the
18+
`algorithms-keeper` bot will close the pull request as invalid. Any repo
19+
maintainer can undo this if you @mention them on the closed pull request.
20+
21+
### 1. Before contributing / Is this an algorithm?
22+
23+
- [ ] The change adds, fixes, or documents **one algorithm** — not multiple, and
24+
not both code and doctest changes in the same PR.
25+
- [ ] It is a genuine algorithm or data structure (see the *What is an Algorithm?*
26+
section), not a script, snippet, how-to-use for an existing API, or exercise
27+
dump.
28+
- [ ] It is **not already in the repository** (search the existing directories).
29+
- [ ] **No earlier open PR** already does the same thing — link it if one exists.
30+
- [ ] Properly attributed — no plagiarism; prior sources credited.
31+
32+
### 2. Coding Style
33+
34+
- [ ] `from __future__ import annotations` is not needed because this repo only uses
35+
the latest version of CPython.
36+
- [ ] File and directory names are lowercase, use underscores, and land inside an
37+
existing directory.
38+
- [ ] Public functions/classes have **type hints**.
39+
- [ ] Public functions have **doctests that actually pass**.
40+
- [ ] Descriptive variable and function names (no single letters where a word helps).
41+
- [ ] Code is formatted and lint-clean (`ruff`, `pre-commit`).
42+
43+
### 3. Other Requirements for Submissions
44+
45+
- [ ] At least one **Wikipedia (or equivalent) URL** documenting the algorithm.
46+
- [ ] Docstring explains what the function does and its parameters/returns.
47+
- [ ] No unnecessary third-party dependencies.

0 commit comments

Comments
 (0)