Skip to content

docs: (CONTRIBUT) #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bromnhub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: (CONTRIBUT) #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!