From 28a4242c6ea350f070fd0c80c82f6474e5e1a6c0 Mon Sep 17 00:00:00 2001
From: Santhosh Gandhe <1909520+san81@users.noreply.github.com>
Date: Sun, 1 Feb 2026 09:55:56 -0800
Subject: [PATCH] Removing duplicate lines and $ sign before the bash commands
 to make quick copy/paste possible of these commands possible. (#719)

Co-authored-by: Santhosh Gandhe <santhosh.gandhe@gmail.com>
---
 CONTRIBUTING.md | 52 +++++++++++++++++++------------------------------
 1 file changed, 20 insertions(+), 32 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2e9ec2f4..9f9b0b9c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,5 @@
 # Contribution
 
-We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Plano**!
 We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Plano**!
 Whether you're fixing bugs, adding new features, improving documentation, or creating tutorials, your help is much appreciated.
 
@@ -8,10 +7,8 @@ Whether you're fixing bugs, adding new features, improving documentation, or cre
 
 ### 1. Fork the Repository
 
-Fork the repository to create your own version of **Plano**:
 Fork the repository to create your own version of **Plano**:
 
-- Navigate to the [Plano GitHub repository](https://github.com/katanemo/plano).
 - Navigate to the [Plano GitHub repository](https://github.com/katanemo/plano).
 - Click the "Fork" button in the upper right corner.
 - This will create a copy of the repository under your GitHub account.
@@ -21,8 +18,8 @@ Fork the repository to create your own version of **Plano**:
 Once you've forked the repository, clone it to your local machine (replace `<your-username>` with your GitHub username):
 
 ```bash
-$ git clone git@github.com:<your-username>/plano.git
-$ cd plano
+git clone git@github.com:<your-username>/plano.git
+cd plano
 ```
 
 ### 3. Add Upstream Remote
@@ -30,15 +27,15 @@ $ cd plano
 Add the original repository as an upstream remote so you can keep your fork in sync:
 
 ```bash
-$ git remote add upstream git@github.com:katanemo/plano.git
+git remote add upstream git@github.com:katanemo/plano.git
 ```
 
 To sync your fork with the latest changes from the main repository:
 
 ```bash
-$ git fetch upstream
-$ git checkout main
-$ git merge upstream/main
+git fetch upstream
+git checkout main
+git merge upstream/main
 ```
 
 ### 4. Install Prerequisites
@@ -46,7 +43,7 @@ $ git merge upstream/main
 **Install uv** (Python package manager for the planoai CLI):
 
 ```bash
-$ curl -LsSf https://astral.sh/uv/install.sh | sh
+curl -LsSf https://astral.sh/uv/install.sh | sh
 ```
 
 **Install pre-commit hooks:**
@@ -54,8 +51,8 @@ $ curl -LsSf https://astral.sh/uv/install.sh | sh
 Pre-commit hooks help maintain code quality by running automated checks before each commit. Install them with:
 
 ```bash
-$ pip install pre-commit
-$ pre-commit install
+pip install pre-commit
+pre-commit install
 ```
 
 The pre-commit hooks will automatically run:
@@ -69,19 +66,12 @@ The pre-commit hooks will automatically run:
 The planoai CLI is used to build, run, and manage Plano locally:
 
 ```bash
-$ cd cli
-$ uv sync
+cd cli
+uv sync
 ```
 
 This creates a virtual environment in `.venv` and installs all dependencies.
 
-Optionally, install planoai globally in editable mode:
-
-```bash
-$ git clone https://github.com/katanemo/plano.git
-$ cd plano
-```
-
 Now you can use `planoai` commands from anywhere, or use `uv run planoai` from the `cli` directory.
 
 ### 6. Create a Branch
@@ -89,7 +79,7 @@ Now you can use `planoai` commands from anywhere, or use `uv run planoai` from t
 Use a descriptive name for your branch (e.g., fix-bug-123, add-feature-x).
 
 ```bash
-$ git checkout -b <your-branch-name>
+git checkout -b <your-branch-name>
 ```
 
 ### 7. Make Your Changes
@@ -101,25 +91,25 @@ Make your changes in the relevant files. If you're adding new features or fixing
 **Run Rust tests:**
 
 ```bash
-$ cd crates
-$ cargo test
+cd crates
+cargo test
 ```
 
 For library tests only:
 ```bash
-$ cargo test --lib
+cargo test --lib
 ```
 
 **Run Python CLI tests:**
 
 ```bash
-$ cd cli
-$ uv run pytest
+cd cli
+uv run pytest
 ```
 
 Or with verbose output:
 ```bash
-$ uv run pytest -v
+uv run pytest -v
 ```
 
 **Run pre-commit checks manually:**
@@ -127,13 +117,11 @@ $ uv run pytest -v
 Before committing, you can run all pre-commit checks manually:
 
 ```bash
-cd plano
-cargo test
+pre-commit run --all-files
 ```
 
-### 6. Push changes, and create a Pull request
+### 9. Push changes, and create a Pull request
 
-Go back to the original Plano repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.
 Go back to the original Plano repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.
 
 We will review your pull request and provide feedback. Once approved, your contribution will be merged into the main repository!