Skip to content

Commit a48e8ed

Browse files
author
Zo Bot
committed
fix: clarify contribution guidelines
1 parent e3b01ec commit a48e8ed

11 files changed

Lines changed: 19 additions & 26 deletions

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- run: sudo apt-get update && sudo apt-get install -y libhdf5-dev
13-
- uses: actions/checkout@v7
13+
- uses: actions/checkout@v6
1414
- uses: astral-sh/setup-uv@v7
1515
with:
1616
enable-cache: true

.github/workflows/devcontainer_ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
build:
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v7
15+
- uses: actions/checkout@v6
1616
- uses: devcontainers/ci@v0.3
1717
with:
1818
push: never

.github/workflows/directory_writer.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
directory_writer:
77
runs-on: ubuntu-latest
88
steps:
9-
- uses: actions/checkout@v7
9+
- uses: actions/checkout@v6
1010
with:
1111
fetch-depth: 0
1212
- uses: actions/setup-python@v6

.github/workflows/project_euler.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
libxml2-dev libxslt-dev
2222
libhdf5-dev
2323
libopenblas-dev
24-
- uses: actions/checkout@v7
24+
- uses: actions/checkout@v6
2525
- uses: astral-sh/setup-uv@v7
2626
- uses: actions/setup-python@v6
2727
with:
@@ -39,7 +39,7 @@ jobs:
3939
libxml2-dev libxslt-dev
4040
libhdf5-dev
4141
libopenblas-dev
42-
- uses: actions/checkout@v7
42+
- uses: actions/checkout@v6
4343
- uses: astral-sh/setup-uv@v7
4444
- uses: actions/setup-python@v6
4545
with:

.github/workflows/ruff.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ jobs:
1111
ruff:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v7
14+
- uses: actions/checkout@v6
1515
- uses: astral-sh/setup-uv@v7
1616
- run: uvx ruff check --output-format=github .

.github/workflows/sphinx.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
libxml2-dev libxslt-dev
3333
libhdf5-dev
3434
libopenblas-dev
35-
- uses: actions/checkout@v7
35+
- uses: actions/checkout@v6
3636
- uses: astral-sh/setup-uv@v7
3737
- uses: actions/setup-python@v6
3838
with:

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ repos:
1919
- id: auto-walrus
2020

2121
- repo: https://github.com/astral-sh/ruff-pre-commit
22-
rev: v0.15.15
22+
rev: v0.15.9
2323
hooks:
2424
- id: ruff-check
2525
- id: ruff-format
@@ -32,7 +32,7 @@ repos:
3232
- tomli
3333

3434
- repo: https://github.com/tox-dev/pyproject-fmt
35-
rev: v2.23.0
35+
rev: v2.21.0
3636
hooks:
3737
- id: pyproject-fmt
3838

CONTRIBUTING.md

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

33
## Before contributing
44

5-
Welcome to [TheAlgorithms/Python](https://github.com/TheAlgorithms/Python)! Before submitting your pull requests, please ensure that you __read the whole guidelines__. If you have any doubts about the contributing guide, please feel free to [state it clearly in an issue](https://github.com/TheAlgorithms/Python/issues/new) or ask the community on [Gitter](https://gitter.im/TheAlgorithms/community).
5+
Welcome to [TheAlgorithms/Python](https://github.com/TheAlgorithms/Python)! Before submitting your pull requests, please ensure that you __read the whole guidelines carefully__. If you have any doubts about the contributing guide, please feel free to [state it clearly in an issue](https://github.com/TheAlgorithms/Python/issues/new) or ask the community on [Gitter](https://gitter.im/TheAlgorithms/community).
66

77
## Contributing
88

@@ -21,7 +21,7 @@ __Improving comments__ and __writing proper tests__ are also highly welcome.
2121

2222
### Contribution
2323

24-
We appreciate any contribution, from fixing a grammar mistake in a comment to implementing complex algorithms. Please read this section if you are contributing your work.
24+
We appreciate any contribution, from fixing a grammatical mistake in a comment to implementing complex algorithms. Please read this section if you are contributing your work.
2525

2626
Your contribution will be tested by our [automated testing on GitHub Actions](https://github.com/TheAlgorithms/Python/actions) to save time and mental energy. After you have submitted your pull request, you should see the GitHub Actions tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button to read through the GitHub Actions output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help.
2727

DIRECTORY.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -471,8 +471,6 @@
471471
* [Geometry](geometry/geometry.py)
472472
* [Graham Scan](geometry/graham_scan.py)
473473
* [Jarvis March](geometry/jarvis_march.py)
474-
* [Ramer Douglas Peucker](geometry/ramer_douglas_peucker.py)
475-
* [Segment Intersection](geometry/segment_intersection.py)
476474
* Tests
477475
* [Test Graham Scan](geometry/tests/test_graham_scan.py)
478476
* [Test Jarvis March](geometry/tests/test_jarvis_march.py)
@@ -525,7 +523,6 @@
525523
* [Graphs Floyd Warshall](graphs/graphs_floyd_warshall.py)
526524
* [Greedy Best First](graphs/greedy_best_first.py)
527525
* [Greedy Min Vertex Cover](graphs/greedy_min_vertex_cover.py)
528-
* [Johnson](graphs/johnson.py)
529526
* [Kahns Algorithm Long](graphs/kahns_algorithm_long.py)
530527
* [Kahns Algorithm Topo](graphs/kahns_algorithm_topo.py)
531528
* [Karger](graphs/karger.py)
@@ -546,7 +543,6 @@
546543
* [Strongly Connected Components](graphs/strongly_connected_components.py)
547544
* [Tarjans Scc](graphs/tarjans_scc.py)
548545
* Tests
549-
* [Test Johnson](graphs/tests/test_johnson.py)
550546
* [Test Min Spanning Tree Kruskal](graphs/tests/test_min_spanning_tree_kruskal.py)
551547
* [Test Min Spanning Tree Prim](graphs/tests/test_min_spanning_tree_prim.py)
552548

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,14 +169,14 @@ skip = """\
169169
python_version = "3.14"
170170

171171
[tool.pytest]
172+
ini_options.markers = [
173+
"mat_ops: mark a test as utilizing matrix operations.",
174+
]
172175
ini_options.addopts = [
173176
"--durations=10",
174177
"--doctest-modules",
175178
"--showlocals",
176179
]
177-
ini_options.markers = [
178-
"mat_ops: mark a test as utilizing matrix operations.",
179-
]
180180

181181
[tool.coverage]
182182
report.omit = [

0 commit comments

Comments
 (0)