You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.
You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think firstly we would have to create a .pre-commit-config.yaml file where we will host the below snippet:
repos:
- repo: https://github.com/pre-commit/mirrors-ruffrev: v0.0.1 # You can specify the version you want to usehooks:
- id: ruff
then we can update our Contributing file with following:
Contributing
============
Setting Up Your Environment
---------------------------
To ensure a consistent code style and catch potential issues, we use `ruff` and `pre-commit` in this project.
1. Install `ruff` and `pre-commit`:
.. code-block:: bash pip install ruff pre-commit
2. Set up `pre-commit` hooks:
.. code-block:: bash pre-commit install
This will install the `pre-commit` hooks defined in the `.pre-commit-config.yaml` file.
3. Running `ruff` manually:
You can run `ruff` manually to check your code for style issues:
.. code-block:: bash ruff .
4. Running `pre-commit` hooks manually:
You can also run all `pre-commit` hooks manually:
.. code-block:: bash pre-commit run --all-files
By following these steps, you'll ensure that your code adheres to the project's style guidelines and passes all pre-commit checks before committing changes.
Activity
speco29 commentedon Feb 11, 2025
hello @martinfleis , I would like to work on this issue.
Can you tell me what file are you talking about here specifically?
martinfleis commentedon Feb 11, 2025
It is this one https://github.com/pysal/momepy/blob/main/docs/contributing.rst but do you know what to change?
speco29 commentedon Feb 11, 2025
By the issue, I got that we had to add ruff and pre-commit there, but more insight would be very helpful.
speco29 commentedon Feb 12, 2025
I think firstly we would have to create a .pre-commit-config.yaml file where we will host the below snippet:
then we can update our Contributing file with following:
let me know if I'm right;)
speco29 commentedon Feb 15, 2025
Should I make PR about it?
martinfleis commentedon Feb 15, 2025
Please check the existing code base first. We do have a pre commit.
The rest is roughly ok.
fixes pysal#633
abhayrajjais01 commentedon Jan 20, 2026
@martinfleis can you please give a little brief about what you really want to change in this