Skip to content

docs: replace black with ruff in contribution guide #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
falloficarus22 wants to merge 5 commits into from
Closed

docs: replace black with ruff in contribution guide #292

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f721bd
Update CONTRIBUTING.md
falloficarus22 Dec 12, 2025
d36a64d
Update CONTRIBUTING.md
falloficarus22 Dec 12, 2025
95c69d6
Update CONTRIBUTING.md
falloficarus22 Dec 12, 2025
2b5ad3e
Update CONTRIBUTING.md
falloficarus22 Dec 12, 2025
3270fe5
Merge branch 'mesa:main' into update-contributing.md
falloficarus22 Dec 15, 2025
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
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ No contribution is too small. Although, contributions can be too big, so let's d
- Git commit your changes with a meaningful message: `git commit -m "Fix issue X"`
- If implementing a new feature, include some documentation in docs folder.
- Make sure that your submission passes the [GH Actions build]. See "Testing and Standards below" to be able to run these locally.
- Make sure that your code is formatted according to the [black] standard (you can do it via [pre-commit]).
- Make sure that your code is formatted according to the [ruff] standard (you can do it via [pre-commit]).
Copy link

@coderabbitai coderabbitai bot Dec 12, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Deduplicate link reference definitions ([ruff], and likely [pre-commit])

Right now [ruff] is defined twice (Line 42 and Line 87), and [pre-commit] appears to be defined twice (Line 41 and Line 86). This triggers markdownlint (MD053) and makes future edits error-prone.

Suggested fix: keep a single definition (commonly at the bottom of the file) and remove earlier duplicates:

-[pre-commit]: https://github.com/pre-commit/pre-commit
-[ruff]: https://github.com/astral-sh/ruff
...
 [PEP8]: https://www.python.org/dev/peps/pep-0008
 [Google Style Guide]: https://google.github.io/styleguide/pyguide.html
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [ruff]: https://github.com/astral-sh/ruff

Also applies to: 42-42, 86-87

🤖 Prompt for AI Agents 
In CONTRIBUTING.md around line 33 (duplicates also at lines 41-42 and 86-87),
there are duplicate reference definitions for [ruff] and [pre-commit]; remove
the earlier duplicate definitions and keep a single canonical definition
(preferably the bottom-of-file reference section), update any references if
necessary so they still resolve, and run markdownlint to confirm MD053 is
resolved.

- Push your changes to your fork on Github: `git push origin NAME_OF_BRANCH`.
- [Create a pull request].
- Describe the change w/ ticket number(s) that the code fixes.
Expand All @@ -39,12 +39,12 @@ No contribution is too small. Although, contributions can be too big, so let's d
[GH Actions build]: https://github.com/mesa/mesa-geo/actions/workflows/build_lint.yml
[Create a pull request]: https://help.github.com/articles/creating-a-pull-request/
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
[ruff]: https://github.com/astral-sh/ruff

Testing and Code Standards
--------------------------

[![](https://codecov.io/gh/projectmesa/mesa-geo/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa-geo) [![](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![](https://codecov.io/gh/projectmesa/mesa-geo/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa-geo) [![](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
Copy link

@coderabbitai coderabbitai bot Dec 12, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add alt text to badges to satisfy accessibility + markdownlint (MD045)

-[![](https://codecov.io/gh/projectmesa/mesa-geo/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa-geo) [![](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![codecov badge](https://codecov.io/gh/projectmesa/mesa-geo/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa-geo)
+[![code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[![](https://codecov.io/gh/projectmesa/mesa-geo/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa-geo) [![](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
[![codecov badge](https://codecov.io/gh/projectmesa/mesa-geo/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa-geo)
[![code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

47-47: Images should have alternate text (alt text)

(MD045, no-alt-text)

47-47: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
CONTRIBUTING.md around line 47: the two inline badge images lack alt text which
triggers accessibility and markdownlint MD045; update the markdown image syntax
to include descriptive alt text for each badge (e.g., "Codecov badge" and "Ruff
code style badge") inside the square brackets before the parentheses, preserving
the existing links and titles so the badges render the same while satisfying
accessibility rules.


As part of our contribution process, we practice continuous integration and use GH Actions to help enforce best practices.

Expand All @@ -68,7 +68,7 @@ We test by implementing simple models and through traditional unit tests in the
pytest --cov=mesa_geo tests/
```

With respect to code standards, we follow [PEP8] and the [Google Style Guide]. We recommend to use [black] as an automated code formatter. You can automatically format your code using [pre-commit], which will prevent `git commit` of unstyled code and will automatically apply black style so you can immediately re-run `git commit`. To set up pre-commit run the following commands:
With respect to code standards, we follow [PEP8] and the [Google Style Guide]. We recommend to use [ruff] as an automated code formatter. You can automatically format your code using [pre-commit], which will prevent `git commit` of unstyled code and will automatically apply ruff style so you can immediately re-run `git commit`. To set up pre-commit run the following commands:

```bash
pip install pre-commit
Expand All @@ -84,7 +84,7 @@ ruff .
[PEP8]: https://www.python.org/dev/peps/pep-0008
[Google Style Guide]: https://google.github.io/styleguide/pyguide.html
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
[ruff]: https://github.com/astral-sh/ruff

Licensing
---------
Expand Down