From c0a2edf8bbcf3bbf19c41a7766a0d795ca0623b8 Mon Sep 17 00:00:00 2001
From: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com>
Date: Wed, 29 Jan 2025 01:27:40 -0800
Subject: [PATCH] Update readme (#1532)

* Add 'Creating a PR' section

* Added tip about versioning
---
 .../unreleased/Added-20250129-010730.yaml     |  3 +++
 README.md                                     | 25 +++++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 .changes/unreleased/Added-20250129-010730.yaml

diff --git a/.changes/unreleased/Added-20250129-010730.yaml b/.changes/unreleased/Added-20250129-010730.yaml
new file mode 100644
index 0000000000..231d5baee1
--- /dev/null
+++ b/.changes/unreleased/Added-20250129-010730.yaml
@@ -0,0 +1,3 @@
+kind: Added
+body: new section to README about Changie
+time: 2025-01-29T01:07:30.285298-08:00
diff --git a/README.md b/README.md
index b742fefcef..ca284cdfb0 100644
--- a/README.md
+++ b/README.md
@@ -160,6 +160,31 @@ To contribute to the project, start with our [Contributing Guide](CONTRIBUTING.m
 
 </details>
 
+<details>
+<summary>Creating a Pull Request</summary>
+
+1. Before creating a PR, generate a changelog entry using [Changie](https://changie.dev/):
+    ```bash
+    npm run changie new
+    ```
+   This will prompt you for:
+   - Kind of change (Added, Changed, Deprecated, Removed, Fixed, Security)
+     - `Added` → triggers minor version bump (1.0.0 → 1.1.0)
+     - `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security` → triggers patch version bump (1.0.0 → 1.0.1)
+     - Breaking changes → triggers major version bump (1.0.0 → 2.0.0)
+   - Description of your changes
+   - Issue number (if applicable)
+
+2. Commit your changes and the generated `.changes` file
+
+3. Push your branch and create a PR on GitHub. Our CI will:
+   - Run tests and checks
+   - When merged to main, automatically batch changelog entries
+   - Create a version PR with the updated CHANGELOG.md
+
+</details>
+
+
 ## License
 
 [Apache 2.0 © 2024 Cline Bot Inc.](./LICENSE)