From 7233a2a62da11b455eeb77dcc19d2a28109949ab Mon Sep 17 00:00:00 2001 From: Harsha Vardhan Reddy B Date: Sun, 1 Nov 2026 14:40:25 +0530 Subject: [PATCH 1/2] docs: remove duplicate algorithm guidelines --- CONTRIBUTING.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c66950b8a7c..b67897470501 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ An algorithm is one or more functions (or classes) that: Algorithms should be packaged in a way that would make it easy for readers to integrate them into larger programs. -Algorithms should: +#### Algorithms should: - have intuitive class and function names that make their purpose clear to readers, - use Python naming conventions and intuitive variable names to ease comprehension, @@ -67,20 +67,6 @@ Algorithms should: Algorithms in this repo should not be simple how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values. These calculations or manipulations can use data types, classes, or functions of existing Python packages, but each algorithm in this repo should add unique value. -#### Pre-Commit Plugin - -- have intuitive class and function names that make their purpose clear to readers -- use Python naming conventions and intuitive variable names to ease comprehension -- be flexible to take different input values -- have Python type hints for their input parameters and return values -- raise Python exceptions (`ValueError`, etc.) on erroneous input values -- have docstrings with clear explanations and/or URLs to source materials -- contain doctests that test both valid and erroneous input values -- return all calculation results instead of printing or plotting them - -Algorithms in this repo should not be how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values. -Those calculations or manipulations can use data types, classes, or functions of existing Python packages, but each algorithm in this repo should add unique value. - #### Pre-commit Use [pre-commit](https://pre-commit.com/#installation) to automatically format your code to match our coding style: From 236b8093edf427e262a55407560d86a18d4793fe Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 1 Nov 2026 09:23:18 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b67897470501..ef93a6daefdb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ An algorithm is one or more functions (or classes) that: Algorithms should be packaged in a way that would make it easy for readers to integrate them into larger programs. -#### Algorithms should: +#### Algorithms should - have intuitive class and function names that make their purpose clear to readers, - use Python naming conventions and intuitive variable names to ease comprehension,