Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .github/skills/code-review/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ suggest the fix — never just "rejected".
- [ ] Descriptive variable and function names (no single letters where a word helps).
- [ ] Code is formatted and lint-clean (`ruff`, `pre-commit`).

> **Optional hint:** When a PR hand-writes a simple class that is mostly a
> bundle of fields (a manual `__init__` plus `__repr__`/`__eq__`), it is worth
> **suggesting** `from typing import NamedTuple` or
> `from dataclasses import dataclass` where they would simplify the code. These
> are underutilized tools that our contributors would benefit from using where
> they make sense. Offer it as an optional improvement, not a blocker — do not
> request changes solely because a class was written the longhand way.

#### When a PR fails `ruff check`

Don't just report the failure — try the mechanical fixes and recommend the one
Expand Down
5 changes: 5 additions & 0 deletions .github/skills/new-pull-request/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ Always check at least one Markdown checkbox in the pull request description (the
- [ ] Public functions/classes have **type hints**.
- [ ] Public functions have **doctests that actually pass**.
- [ ] Descriptive variable and function names (no single letters where a word helps).
- [ ] For a simple class that is mostly a bundle of fields, **consider**
`from typing import NamedTuple` or `from dataclasses import dataclass`
instead of a hand-written `__init__`/`__repr__`/`__eq__`. These are
underutilized tools that make simple classes shorter and clearer — use
them where they genuinely simplify the code, not everywhere.
- [ ] Code is formatted and lint-clean (`ruff`, `pre-commit`).
- [ ] `DIRECTORY.md` and `README.md` are **not hand-edited** — the
`algorithms-keeper` bot regenerates them automatically after merge.
Expand Down
Loading