Skip to content

Commit a394b80

Browse files
authored
Update code review guidelines in SKILL.md (#15172)
* Update code review guidelines in SKILL.md Clarify criteria for code review and coding style. * updating DIRECTORY.md * Fix formatting issues in SKILL.md --------- Co-authored-by: cclauss <cclauss@users.noreply.github.com>
1 parent 6e0a4d4 commit a394b80

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

.github/skills/code-review/SKILL.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Review a pull request against the rules already written in
44
[`CONTRIBUTING.md`](../../../CONTRIBUTING.md). The goal is a review that any
5-
reviewer (human or AI) can run the same way every time and that produces a clear,
5+
reviewer (human or AI) can run the same way every time, and that produces a clear,
66
kind, actionable verdict.
77

88
## How to run this skill
@@ -16,13 +16,16 @@ suggest the fix — never just "rejected".
1616
- [ ] The change adds, fixes, or documents **one algorithm** — not multiple, and
1717
not both code and doctest changes in the same PR.
1818
- [ ] It is a genuine algorithm or data structure (see the *What is an Algorithm?*
19-
section), not a script, snippet, or exercise dump.
19+
section), not a script, snippet, how-to-use for an existing API, or exercise
20+
dump.
2021
- [ ] It is **not already in the repository** (search the existing directories).
2122
- [ ] **No earlier open PR** already does the same thing — link it if one exists.
2223
- [ ] Properly attributed — no plagiarism; prior sources credited.
2324

2425
### 2. Coding Style
2526

27+
- [ ] `from __future__ import annotations` is not needed because this repo only uses
28+
the latest version of CPython.
2629
- [ ] File and directory names are lowercase, use underscores, and land inside an
2730
existing directory.
2831
- [ ] Public functions/classes have **type hints**.

DIRECTORY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,7 @@
462462

463463
## Fuzzy Logic
464464
* [Fuzzy Operations](fuzzy_logic/fuzzy_operations.py)
465+
* [Fuzzy Set Operations](fuzzy_logic/fuzzy_set_operations.py)
465466

466467
## Genetic Algorithm
467468
* [Basic String](genetic_algorithm/basic_string.py)

0 commit comments

Comments
 (0)