Skip to content

Commit

Permalink
fix(docs): Update development setup steps and installation commands
Browse files Browse the repository at this point in the history
- Simplify development environment setup steps in CONTRIBUTING.md and add a warning about pre-commit configuration
- Unify the method for installing dependencies and activating the virtual environment in README.md using `make install`
  • Loading branch information
K-dash committed Jul 24, 2024
1 parent 2fc17b0 commit 1a8d4bd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,10 @@ Once you find an interesting issue let us know that you want to work on it by co

## Development
### Install our development environment
1. Please set up your development environment by referring to the `Setup` section in the `README.md`.
Please set up your development environment by referring to the `Setup` section in the `README.md`.

2. Install the `pre-commit`:
```
pre-commit install
```
> [!WARNING]
> Make sure to run `make install` to ensure that lint and format are executed reliably when using the `git commit` command.
### Code Style and Quality
- The [PEP 8](https://realpython.com/python-pep8/) styling convention is used.
Expand Down
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,12 @@ To use cli-surf, clone the project locally and install the necessary dependencie
cd cli-surf
```

3. Install dependencies using Poetry.
3. Install dependencies and Activate the virtual environment.
```bash
poetry install
make install
```

4. Activate the virtual environment.
```bash
poetry shell
```

5. Run the project. For example, if the entry point is `server.py`, use the following command.
4. Run the project. For example, if the entry point is `server.py`, use the following command.
```bash
python src/server.py
Expand Down

0 comments on commit 1a8d4bd

Please sign in to comment.