Skip to content

Commit c431cb0

Browse files
authored
docs: add releasing guidelines for agents (#31)
1 parent 8da4ba7 commit c431cb0

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,29 @@ Key points:
291291

292292
---
293293

294-
## 7. Commit & Pull Request Guidelines
294+
## 7. Releasing
295+
296+
The workflow in .github/workflows/release.yml will create a new release automatically when the version of the crate changes in Cargo.toml in the default git branch.
297+
So, if you attempt to release a new version, you need to update this version. You should try releasing a new version when you do any meaningful change that the user can benefit from.
298+
The guidelines to follow would be:
299+
300+
* New feature is implemented -> Release new version.
301+
* Bug fixes -> Release new version.
302+
* CI/Refactorings/Internal changes -> No need to release new version.
303+
* Documentation changes -> No need to release new version.
304+
305+
The current version of the LSP is not stable yet, so you need to follow the [Semver spec](https://semver.org/spec/v2.0.0.html), with the following guidelines:
306+
307+
* Unless specified, do not attempt to stabilize the version. That is, do not try to update the version to >=1.0.0. Versions for now should be <1.0.0.
308+
* For minor changes, update only the Y in 0.X.Y. For example: 0.5.2 -> 0.5.3
309+
* For major/feature changes, update the X in 0.X.Y and set the Y to 0. For example: 0.5.2 -> 0.6.0
310+
311+
After the commit is merged into the default branch the workflow will cross-compile the project, create a GitHub release of that version, and upload the artifacts to the release.
312+
Check the workflow file in case of doubt.
313+
314+
---
315+
316+
## 8. Commit & Pull Request Guidelines
295317

296318
To keep history clean and reviews manageable:
297319

0 commit comments

Comments
 (0)