phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-10-12 13:57:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(dev): use pre-commit to identify api changes

Browse source
This commit is contained in:
Matthew Farrellee 2025-08-26 18:09:58 -04:00
parent 9fa69b0337
commit 7083fdd593
2 changed files with 24 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -42,7 +42,7 @@ uv run --env-file .env -- pytest -v tests/integration/inference/test_text_infere
We use [pre-commit](https://pre-commit.com/) to run linting and formatting checks on your code. You can install the pre-commit hooks by running:
```bash
uv run pre-commit install
uv run pre-commit install -t pre-commit -t commit-msg
```
After that, pre-commit hooks will run automatically before each commit.
@ -57,6 +57,8 @@ uv run pre-commit run --all-files
Before pushing your changes, make sure that the pre-commit hooks have passed successfully.
```
A note about API changes: We use a commit-msg hook and OpenAPI spec generation to detect API changes. When changing the API, you must add `[API CHANGE]` to your commit message to pass the check.
## Discussions -> Issues -> Pull Requests
We actively welcome your pull requests. However, please read the following. This is heavily inspired by [Ghostty](https://github.com/ghostty-org/ghostty/blob/main/CONTRIBUTING.md).