Update readme (#1532)

* Add 'Creating a PR' section

* Added tip about versioning
This commit is contained in:
Saoud Rizwan 2025-01-29 01:27:40 -08:00 committed by GitHub
parent 5c8ea9fafa
commit c0a2edf8bb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 28 additions and 0 deletions

View file

@ -0,0 +1,3 @@
kind: Added
body: new section to README about Changie
time: 2025-01-29T01:07:30.285298-08:00

View file

@ -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)