From 48e82b909365da6ecedd4ca08e614e5667b88350 Mon Sep 17 00:00:00 2001 From: clavedeluna Date: Mon, 19 Feb 2024 10:39:54 -0300 Subject: [PATCH] update contributing.md --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c11f1fd6..2be98a8da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,7 @@ ## Pre-commit install We use [pre-commit](https://pre-commit.com/) to run some quick linting such as `black` and `ruff`. +This also runs in CI. ## Local Development @@ -13,11 +14,11 @@ but for local development here is a good workflow. 1. To use virtualenv, create an environment with `virtualenv pixeeenv` or `/usr/bin/env python3 -m venv pixeeenv` to specify a specific Python version. If using `bash` or any compatible shell, activate with `source pixeeenv/bin/activate`. Otherwise, look at [`venv`'s documentation](https://docs.python.org/3/library/venv.html) for instructions. -1. `cd codemodder-python` and `pip install -e .` to install the package in development mode +2. `cd codemodder-python` and `pip install -e .` to install the package in development mode -1. Run `pip install ".[all]"` to install packages used for development and testing +3. Run `pip install ".[all]"` to install packages used for development and testing -1. You should now be able to run `ruff`, `pytest`, etc. +4. You should now be able to run `ruff`, `pytest`, etc. ## Docker