Skip to content

docs: fix outdated references in CONTRIBUTING.md#14594

Open
yash1511-bogam wants to merge 1 commit intoTheAlgorithms:masterfrom
yash1511-bogam:fix-contributing-md-inaccuracies
Open

docs: fix outdated references in CONTRIBUTING.md#14594
yash1511-bogam wants to merge 1 commit intoTheAlgorithms:masterfrom
yash1511-bogam:fix-contributing-md-inaccuracies

Conversation

@yash1511-bogam
Copy link
Copy Markdown

@yash1511-bogam yash1511-bogam commented Apr 27, 2026

Describe your change:

Fix several outdated/incorrect references in CONTRIBUTING.md:

  1. Python version: Updated from 3.13+ to 3.14+ to match pyproject.toml (requires-python = ">=3.14")
  2. Code formatter: Replaced outdated black recommendation with ruff format, which is what the project actually uses (see .pre-commit-config.yaml: ruff-check + ruff-format)
  3. PEP 8 URL: Updated https://www.python.org/dev/peps/pep-0008/ to canonical https://peps.python.org/pep-0008/ (old URL 302-redirects to new)
  4. mypy URL: Fixed inconsistent http://www.mypy-lang.org to https://mypy-lang.org (matching the other mypy reference in the same file)
  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

- 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
Copilot AI review requested due to automatic review settings April 27, 2026 18:46
@algorithms-keeper algorithms-keeper Bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Apr 27, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates contributor documentation to reflect current project tooling and links (Python version requirement, formatter, and canonical URLs).

Changes:

  • Update stated minimum Python version to 3.14+ to match pyproject.toml.
  • Replace black formatting guidance with ruff format.
  • Refresh documentation links (canonical PEP 8 URL and HTTPS mypy homepage).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@algorithms-keeper algorithms-keeper Bot added the tests are failing Do not merge until tests pass label Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files tests are failing Do not merge until tests pass

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants