CONTRIBUTING.md

Contributing

Any contributions are welcome!

Open new issues at https://github.com/verda-cloud/sdk-python/issues.

You can open pull requests by following the steps:

Code Contribution

Prerequisite: install uv.

1. Fork this repo on GitHub.

2. Clone your fork locally:

   git clone git@github.com:{your_username}/sdk-python.git
   cd sdk-python

3. Set up local environment and install dependencies:

   uv sync

4. Create a new branch:

   if it's a feature:

   git checkout -b feature/new-feature-name

   or a bugfix:

   git checkout -b fix/some-bugfix

5. Make your local changes

6. Run tests:

   uv run pytest

7. Commit and push:

   git commit -am "Detailed commit message"
   git push origin {branch-name}

8. Submit a pull request in GitHub.

Pull Request Guidelines

1. The pull request should include tests.
2. Please add documentation docstrings and type hinting to any new feature.

Release Guidelines

To release a new version:

1. Bump version:

   uv version --bump minor # also `major` or `patch`

2. Update CHANGELOG.md

3. Commit and push:

   git commit -m v$(uv version --short) CHANGELOG.md pyproject.toml uv.lock
   git tag v$(uv version --short)
   git push origin master
   git push --tags

4. Draft and publish a new release.

5. Check that package is automatically published to PyPI via GitHub action.