mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-08-28 05:27:24 +00:00
Update readme (#1532)
* Add 'Creating a PR' section * Added tip about versioning
This commit is contained in:
parent
5c8ea9fafa
commit
c0a2edf8bb
2 changed files with 28 additions and 0 deletions
3
.changes/unreleased/Added-20250129-010730.yaml
Normal file
3
.changes/unreleased/Added-20250129-010730.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
kind: Added
|
||||
body: new section to README about Changie
|
||||
time: 2025-01-29T01:07:30.285298-08:00
|
||||
25
README.md
25
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)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue