Skip to content

Commit fb359c5

Browse files
committed
docs(contributing): add Conventional Commits format guidelines
1 parent c7aed17 commit fb359c5

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@ Add a comment on the issue and wait for the issue to be assigned before you star
2323
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
2424

2525
1. Fork the repo and create your branch from `main`.
26-
2. If you've added code that should be tested, add tests.
27-
3. Ensure the test suite passes.
28-
4. Make sure your code lints.
29-
5. Issue that pull request!
26+
2. Ensure local prerequisites are installed (Go 1.20+, Node.js 18+, and Helm 3.4+).
27+
3. Follow [Conventional Commits](https://www.conventionalcommits.org/) format (`feat`, `fix`, `docs`, `refactor`, `style`, `chore`).
28+
4. If you've added code that should be tested, add unit or integration tests (`go test ./...` / `npm run lint`).
29+
5. Ensure the test suite passes (`make test`).
30+
6. Make sure your code lints properly.
31+
7. Issue that pull request!
3032

3133
## Any contributions you make will be under the Apache License 2.0
3234

0 commit comments

Comments
 (0)