Skip to content

Commit d330303

Browse files
authored
Update CONTRIBUTING.md
Signed-off-by: Diogo Goncalves <diogoncalves@users.noreply.github.com>
1 parent 2a5b4fb commit d330303

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,30 @@ Thank you for expressing your interest in contributing to LLMstudio. To ensure t
99
3. Follow our repo guidelines
1010
- Ensure that you update any relevant docstrings and comments within your code
1111
- Run `pre-commit run --all-files` to lint your code
12+
4. Sign your commits. Without signed commits, your changes will not be accepted for main.
1213

1314
## Branches
1415

1516
- All development happens in per-feature branches prefixed by contributor's
1617
initials. For example `feat/feature_name`.
1718
- Approved PRs are merged to the `main` branch.
19+
20+
## Alpha releases:
21+
You need to have your changes in the `develop` branch in order to push a new alpha version of any library `(llmstudio, llmstudio-proxy, llmstudio-tracker)`. Therefore, first guarantee that you feature branch is reviewed and working before merging to develop.
22+
23+
Process:
24+
- Ensure the `feature/**` you worked is passing the tests and has the approvals necessary.
25+
- Merge to `develop`
26+
- Ensure the changes are in the develop branch
27+
- Use GitHub Actions to initiate the pre-release process: [PyPI pre-release any module](https://github.com/TensorOpsAI/LLMstudio/actions/workflows/upload-pypi-dev.yml)
28+
- Select the target library `(llmstudio, llmstudio-proxy, llmstudio-tracker)` and the target version for the final release (e.g., 1.1.0). Consult main branch and PyPI for current versions.
29+
- Run the workflow.
30+
- The workflow will automatically bump the version and create an alpha release of the library/module specified
31+
- The workflow will automatically push changes back (bump version) to the develop branch
32+
33+
Repeat the process in case your `development` branch contains changes in multiple libraries.
34+
35+
## Final releases:
36+
Once you're happy with the versions, create the Release notes on the PR between `develop` and `main` and merge to main branch when ready for full release. The workflow will automatically remove any `alpha` tag in your libraries and push the versions for every library/module that suffered changes.
37+
38+

0 commit comments

Comments
 (0)