diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..6e952cb --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing to Vapi Python Client SDK + +Thank you for considering contributing to the Vapi Python Client SDK! We welcome contributions from the community. + +## How to Contribute + +1. **Fork** the repository. +2. **Clone** your fork. +3. **Create a new branch** for your feature or fix: `git checkout -b feature/my-new-feature`. +4. **Make your changes**. +5. **Write tests** that cover your changes. +6. **Ensure all tests pass**. +7. **Commit your changes** using a descriptive commit message (e.g., `feat: Add support for new webhook event`). +8. **Push** your branch to your fork. +9. **Open a Pull Request** against the `main` branch of the original repository. + +## Commit Message Guidelines + +We follow the Conventional Commits specification. Please use the following prefixes: + +* `feat`: A new feature. +* `fix`: A bug fix. +* `docs`: Documentation only changes. +* `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). +* `refactor`: A code change that neither fixes a bug nor adds a feature. +* `perf`: A code change that improves performance. +* `test`: Adding missing tests or correcting existing tests. +* `build`: Changes that affect the build system or external dependencies. +* `ci`: Changes to our CI configuration files and scripts. +* `chore`: Other changes that don't modify src or test files. + +Thank you for helping us improve the Vapi Python Client SDK!