Skip to content

Commit ce348f3

Browse files
committed
add dev readme and instructions
1 parent c5fa61d commit ce348f3

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

DEV_README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Developing codemodder-python
2+
3+
## Pre-commit install
4+
5+
We use [pre-commit](https://pre-commit.com/) to run some quick linting such as `black`.
6+
While pre-commit isn't configured in CI, `black` is. `pylint` and running tests are not configured
7+
for pre-commit so commiting is fast.
8+
9+
10+
## Local Development
11+
12+
In general you can rely on Github workflows to see how to run things like linting and tests,
13+
but for local development here is a good workflow.
14+
15+
1. To use virtualenv, create an environment with `virtualenv pixeeenv` or `/usr/local/bin/python3.11 -m venv pixeeenv`
16+
to specify a specific Python version. Activate with `pixeeenv/bin/activate`
17+
18+
2. `cd codemodder-python` and run `pip install -r` on all the files under `requirements/`
19+
20+
3. You should now be able to run `pylint`, `pytest`, etc.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ You can run the codemodder program with
77
```bash
88
python -m codemodder --help
99
```
10+
11+
## Development
12+
See DEV_README.md

0 commit comments

Comments
 (0)