docs(ci): add README in .github folder

This commit is contained in:
Luc Georges 2024-06-26 15:33:38 +02:00
parent 551e3f0114
commit da60c7264a
No known key found for this signature in database
GPG Key ID: 8A2B84C1466CDF50

8
.github/README.md vendored Normal file
View File

@ -0,0 +1,8 @@
# CI pipelines
## Release
To create a new release for `lsp-ai`, all you'll need to do is create a new branch with the following format: `release/{release_name}`. `release_name` is usually the version of the release package in SemVer format `x.x.x{-rcx}`.
This has the advantage of being able to fix issues for a specific release while continuing developping on the `main` branch by cherry-picking patches. It's inspired by trunk-based development.