Skip to content

Commit 369496d

Browse files
author
Mattia Baldari
committed
Add development setup documentation
Add new 'Development Setup' section to README with: - Instructions for setting up local development environment - How to install and use pre-commit hooks - Commands for running linting checks manually This helps new contributors get started quickly and understand the project's development workflow.
1 parent a5864ae commit 369496d

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,35 @@ The lib requires python3.6 or greater to work. In order to install it run
3737
$ python3 -m pip install graphql-schema-diff
3838
```
3939

40+
## Development Setup
41+
If you want to contribute to this project, follow these steps to set up your development environment:
42+
43+
```bash
44+
# Clone the repository
45+
$ git clone https://github.com/octoenergy/graphql-schema-diff.git
46+
$ cd graphql-schema-diff
47+
48+
# Install the package in development mode with dev dependencies
49+
$ pip install -e ".[dev]"
50+
51+
# Install pre-commit hooks (recommended)
52+
$ pre-commit install
53+
```
54+
55+
The pre-commit hooks will automatically run `ruff` linting and formatting checks before each commit.
56+
You can also run the checks manually:
57+
58+
```bash
59+
# Run all pre-commit hooks on all files
60+
$ pre-commit run --all-files
61+
62+
# Run ruff linter
63+
$ ruff check .
64+
65+
# Run ruff formatter
66+
$ ruff format .
67+
```
68+
4069
## Usage
4170
You can use this package as a lib or as a CLI. You can choose what better suits your needs
4271

0 commit comments

Comments
 (0)