55 Commits
Author SHA1 Message Date
priya-sundaram-devpre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>Christian Clauss
78e489f5dd CI: Upgrade to free-threaded Python 3.15t (#15105)
* ci: try Python 3.15 release candidate (DRAFT)

Point the repo's .python-version at 3.15 so every workflow that reads
python-version-file runs on the 3.15 release candidate (allow-prereleases
is already enabled across all workflows). Add the 3.15 trove classifier
and bump scipy>=1.18.1, which is the first scipy with cp315 manylinux
wheels, so uv installs it as a wheel rather than building from source.

Rebuilt on current master: the earlier version of this PR edited the
per-workflow `python-version: 3.14` lines, but master has since moved
the interpreter to a single `.python-version` file, so the change is now
a one-line switch there.

Purpose is to document which dependencies/tests are not yet 3.15-ready.
Must stay DRAFT until Python 3.15 GA (early October). Requested in #15081.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Upgrade to Python 3.15t

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
2026-09-26 18:06:56 +02:00
jiangnan0541 f56e349693 docs: fix typo pslease to please in CONTRIBUTING.md (#15375) 2026-09-18 11:43:10 +02:00
Fofonoff cc6c9e430d Removed duplicate bullet points in CONTRIBUTING.md (#15271)
* Removed duplicate bullet points in CONTRIBUTING.md

* comma
2026-09-10 19:15:07 +02:00
Umang Dadhichpre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>umang-dadhichChristian Clauss
43cb26cb3d Fix formatting and grammar in CONTRIBUTING.md 🍉 (#12894)
* Fix formatting and grammar in CONTRIBUTING.md 🍉

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* updating DIRECTORY.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* commited

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Warp long line 72 to placate rumdl in pre-commit

CONTRIBUTING.md:72:351: [MD013] Line length 376 exceeds 350 characters

* Revise pre-commit instructions and docstring guidelines

Updated the CONTRIBUTING.md file to clarify pre-commit plugin usage and improve docstring requirements.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Improve comments guidelines in CONTRIBUTING.md

Reorganize comments on code explanation for clarity.

* Update forward propagation reference link

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: umang-dadhich <umang-dadhich@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
2026-09-10 15:49:18 +02:00
Christian Claussandcclauss 3725b917aa pre-commit: Add zizmor and replace prettier with rumdl (#15236)
* pre-commit: Add zizmor and replace prettier with rumdl

* updating DIRECTORY.md

---------

Co-authored-by: cclauss <cclauss@users.noreply.github.com>
2026-09-09 09:55:19 +01:00
YashwanthandChristian Clauss 23c147e1b5 docs: fix outdated references in CONTRIBUTING.md (#15188)
* docs: fix outdated references in CONTRIBUTING.md

- Update Python version from 3.13+ to 3.14+ (matches pyproject.toml)
- Replace outdated black formatter recommendation with ruff format (matches .pre-commit-config.yaml)
- Update PEP 8 URL to canonical peps.python.org (old URL 302-redirects)
- Fix inconsistent mypy URL from http://www.mypy-lang.org to https://mypy-lang.org

* docs: point CONTRIBUTING.md at the tooling CI actually runs

- `ruff .` -> `ruff check .`: bare `ruff .` fails with "unrecognized
  subcommand '.'"; .github/workflows/ruff.yml runs `ruff check ... .`
- mypy -> ty: the mirrors-mypy pre-commit hook is commented out and no
  workflow runs mypy, while .github/workflows/ty.yml runs `ty check` on
  every pull request
- requirements.txt -> pyproject.toml: requirements.txt was deleted in
  #13486 ("dependencies are in pyproject.toml")

* docs: note that the ty check is informational

Addresses Copilot review feedback: .github/workflows/ty.yml sets
`continue-on-error: true` and passes `--exit-zero` ("ty is not yet a
required gate"), so the previous wording implied an enforced gate.

* Apply batched suggestions from code review

Co-authored-by: Christian Clauss <cclauss@me.com>

* Fix grammar and punctuation in CONTRIBUTING.md

Correct grammar and punctuation throughout the document for clarity and consistency.

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
2026-09-05 09:51:05 +02:00
Christian Claussandcclauss 63103f469e Add uv-pre-commit (#15109)
* Add uv-pre-commit

* updating DIRECTORY.md

---------

Co-authored-by: cclauss <cclauss@users.noreply.github.com>
2026-08-30 12:49:06 +02:00
71c7fc8eed docs: upgrade mypy link to https (#14184)
Co-authored-by: JavedKhan93 <javed58725@gmail.com>
Co-authored-by: Maxim Smolskiy <mithridatus@mail.ru>
2026-03-09 08:09:38 +03:00
OmkaarChristian Clausspre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
3cea94179d Fix a few typos (#13346)
* Fix typo in spheres intersection print statement

* Fix typo in CONTRIBUTING.md

* Improve comments in comb_sort.py

* pyproject.toml: tool.ruff.target-version = "py314"

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix comment formatting in lint.ignore section

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-10-15 19:35:55 +02:00
Christian Clauss e9e7c96465 Create GitHub Pages docs with Sphinx (#11888) 2024-10-08 19:09:28 +02:00
Andrey IvanovandTianyi Zheng ad6395d340 Update ruff usage example in CONTRIBUTING.md (#11772)
* Update ruff usage example

* Update CONTRIBUTING.md

Co-authored-by: Tianyi Zheng <tianyizheng02@gmail.com>

---------

Co-authored-by: Tianyi Zheng <tianyizheng02@gmail.com>
2024-10-05 10:24:58 -07:00
Kishan Kumar Rai 8adbf47c75 Fix Typo & Grammatical Errors (#10980) 2023-10-26 14:51:28 +02:00
Chris O dffbe458c0 Update contributing guidelines to say not to open new issues for algorithms (#9760)
* updated CONTRIBUTING.md with markdown anchors and issues

* removed testing header from previous PR
2023-10-05 13:26:33 +02:00
Christian Claussandgithub-actions 0f4e51245f Upgrade to Python 3.12 (#9576)
* DRAFT: GitHub Actions: Test on Python 3.12

Repeats #8777
* #8777 

Some of our dependencies will not be ready yet.

* Python 3.12: Disable qiskit and tensorflow algorithms

* updating DIRECTORY.md

---------

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2023-10-03 14:47:10 +05:30
Tianyi ZhengandChristian Clauss f7531d9874 Add note in CONTRIBUTING.md about not asking to be assigned to issues (#8871)
* Add note in CONTRIBUTING.md about not asking to be assigned to issues

Add a paragraph to CONTRIBUTING.md explicitly asking contributors to not ask to be assigned to issues

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
2023-07-22 12:11:04 +02:00
Tianyi ZhengChristian Claussgithub-actionspre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
267a8b72f9 Clarify how to add issue numbers in PR template and CONTRIBUTING.md (#8833)
* updating DIRECTORY.md

* Clarify wording in PR template

* Clarify CONTRIBUTING.md wording about adding issue numbers

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add suggested change from review to CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Incorporate review edit to CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

---------

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
2023-06-23 15:56:58 +02:00
Christian VeenhuisandChristian Clauss 86b2ab09aa Fix broken links to Gitter Community (Fixes: #8197) (#8546)
Co-authored-by: Christian Clauss <cclauss@me.com>
2023-03-26 18:20:47 +02:00
GenesisandChristian Clauss 7cdb011ba4 New gitter link added or replaced (#8551)
* New gitter link added

* ruff==0.0.258

* noqa: S310

* noqa: S310

* Update ruff.yml

* Add Ruff rule S311

* Ruff v0.0.259

* return ("{:08x}" * 5).format(*self.h)

* pickle.load(f)  # noqa: S301

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
2023-03-26 17:19:18 +02:00
Christian Clauss 521fbca61c Replace flake8 with ruff (#8184) 2023-03-16 13:31:29 +01:00
Christian Claussandgithub-actions a31edd4477 Test on Python 3.11 (#6591)
* Test on Python 3.11 release candidate 2

* tensorflow; python<3.11

* tensorflow; python_version < 3.11

* tensorflow; python_version < "3.11"

* sympy, tensorflow; python_version < "3.11"

* sklearn; python_version < "3.11"

* matplotlib, pandas, qiskit

* statsmodels; python_version < "3.11"

* Bring back Pandas

* Problem deps are qiskit, statsmodels, and tensorflow

* updating DIRECTORY.md

* python-version: 3.11-dev --> 3.11

* updating DIRECTORY.md

* Add pytest --ignore to pyproject.toml

* Update build.yml

* Update pyproject.toml

* Update pyproject.toml

* Python 3.11

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2022-10-31 14:50:03 +01:00
Andreyandgithub-actions 57ccabbaeb Update docs (#7867)
* Update docs, remove unused excludes from pre-commit

* updating DIRECTORY.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2022-10-30 10:01:58 +01:00
dmorozov001 d84452344a Correcting typos in CONTRIBUTING.md (#7845) 2022-10-29 16:43:03 +02:00
Tarun Jain a84fb58271 Discord Server invite (#6663) 2022-10-04 18:40:53 +02:00
Maxim Smolskiy 37bc6bdebf Replace Travis CI mentions with GitHub actions (#5751) 2021-11-02 22:28:09 +01:00
Mitheel 359e0e795e Fixed grammatical errors in CONTRIBUTING.md (#5635) 2021-10-30 21:48:50 +02:00
Mitheel b72a66b713 Fixed grammatical errors in CONTRIBUTING.md (#5555) 2021-10-23 14:54:41 +02:00
Rohan R Bharadwaj 21cf3cc260 Typo (#5443) 2021-10-19 21:36:01 +02:00
polosoandgithub-actions 9586a6a98e Change comments for improved consistency (#5223)
* Change comments for improved consistency

https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#L56
https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#L80
https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#L87

* updating DIRECTORY.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2021-10-12 00:44:38 +08:00
Christian Clauss 10d38eae67 CONTRIBUTING.md: Write for current Python (#4507) 2021-06-13 09:59:06 +05:30
Vivian DaiandChristian Clauss 04f156a897 markdown consistency (#4461)
* markdown consistency

* Swap ** for __

Co-authored-by: Christian Clauss <cclauss@me.com>
2021-05-31 10:56:11 +02:00
algobytewiseandChristian Clauss ffa53c02a7 Include mypy instructions in CONTRIBUTING.md (#4271)
* reupload

* Include mypy instructions

* delete file

* fixed trailing whitespaces

* options before file path

Co-authored-by: Christian Clauss <cclauss@me.com>
2021-03-19 11:29:54 +01:00
8cafadd759 Update CONTRIBUTING.md with pre-commit plugin instructions (#3979)
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
2020-11-28 19:09:27 +05:30
John Lawandgithub-actions a5aef147e9 Fix Project Euler Readme (#3754)
* Fix Project Euler Readme

* updating DIRECTORY.md

* Update CONTRIBUTING.md

* spacing

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2020-10-26 21:18:57 +05:30
47199c123c Update CONTRIBUTING.md (#3698)
* Update CONTRIBUTING.md

Needed to tell people so we do not receive any duplicate solution. Do not count this as hactoberfest-accepted

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

typo fix

Co-authored-by: Du Yuanchao <shellhub.me@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Du Yuanchao <shellhub.me@gmail.com>
Co-authored-by: John Law <johnlaw.po@gmail.com>
2020-10-26 14:35:49 +08:00
forgithub0001 e551004551 Update CONTRIBUTING.md (#3223) 2020-10-12 14:08:50 +05:30
f7e7ad2ef6 CONTRIBUTING.md Jupyter files belong in the Jupyter repo. (#3211)
* CONTRIBUTING.md Jupyter files belong in the Jupyter repo.

* updating DIRECTORY.md

* Update CONTRIBUTING.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: John Law <johnlaw.po@gmail.com>
2020-10-12 08:17:26 +08:00
Muskan KumarandChristian Clauss e92e433dbe Update CONTRIBUTING.md (#2378)
* Update CONTRIBUTING.md

fixed dead link to the license

* Update README.md

Added License

* Update README.md

* Update README.md

* Update README.md

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>
2020-08-31 21:34:44 +02:00
Kushagra Bansal 051be078e4 Fix typo (#2325) 2020-08-17 17:43:46 +02:00
Christian Claussandgithub-actions 4e8a0d924e CONTRIBUTING.md: Update flake8 command (#2124)
* CONTRIBUTING.md: Update flake8 command

* updating DIRECTORY.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2020-06-16 16:33:17 +02:00
Sanders Lin 0feed0bfb8 Update CONTRIBUTING.md (#1886) 2020-04-17 20:03:36 +02:00
Christian Claussandgithub-actions d48661e35d CONTRIBUTING.md: What is an Algorithm? (#1885)
* CONTRIBUTING.md: What is an Algorithm?

We are seeing too many _how-to examples_ for using existing Python packages so we should define what we want algorithm contributions to be.

* updating DIRECTORY.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2020-04-17 12:42:00 +02:00
Christian Claussandgithub-actions 8bf380ce7d README.md: sumab() --> sum_ab() for consistancy (#1855)
* README.md: sumab() --> sum_ab() for consistancy  

consistency

* fixup! Format Python code with psf/black push

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
2020-04-12 17:18:30 +02:00
Christian Clauss 8f2c9932e0 CONTRIBUTING.md: Fix comments about the black formatter (#1841)
* CONTRIBUTING.md: Fix comments about the black formatter

Fixes #1840

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md
2020-04-08 12:27:11 +02:00
Brian Larsen e5f7fbcc9e Change gitpod configuration for python3. (#1827) 2020-04-07 12:20:08 +02:00
5c7d7782b0 Mandates referencing issue in PR (#1717)
* Mandates referencing issue in PR

* Update CONTRIBUTING.md

* Update pull_request_template.md

* Update pull_request_template.md

* Update pull_request_template.md

* Update CONTRIBUTING.md

Co-authored-by: John Law <johnlaw.po@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
2020-01-27 21:54:57 +01:00
John Law 56830255ca Readability of CONTRIBUTING.md (#1422)
* Readability of guidelines

* Update README.md
2019-10-23 04:07:50 +08:00
Christian Clauss 6ebd899c01 CONTRIBUTING.md: Fix mistake in doctest ;-) (#1266)
* CONTRIBUTING.md: Fix mistake in doctest ;-)

* Update CONTRIBUTING.md
2019-10-05 23:32:58 +08:00
Christian Clauss df44d1b703 Update CONTRIBUTING.md (#1250)
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Add Python type hints and mypy
2019-10-02 21:49:00 +05:30
Christian Clauss 47a9ea2b0b Simplify code by dropping support for legacy Python (#1143)
* Simplify code by dropping support for legacy Python

* sort() --> sorted()
2019-08-19 15:37:49 +02:00
John Law b35f5d971b Update CONTRIBUTING.md (#1059) 2019-07-20 18:40:00 +02:00