diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5cf58a9..f978e55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index f116338..70a13db 100644 --- a/README.md +++ b/README.md @@ -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