Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (14 loc) · 998 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (14 loc) · 998 Bytes

Contributing

Hi! Thanks for your interest in contributing to the VulnCheck Python SDK!

Design

The VulnCheck Python SDK is auto-generated using OpenAPI Generator. This allows us to keep the SDK in-sync with the current state of the client using the OpenAPI endpoint.

If you find a bug in the SDK please submit a bug with this template. If you'd like to see a new feature, please use the feature request template.

Working on the project locally

Prerequisites:

  • Python 3.7+

Run tests with: make test

Submitting a pull request

  1. Create a new branch: git checkout -b my-branch-name
  2. Make your change, add tests, and ensure tests pass
  3. Update any relevant documentation
  4. Submit a pull request: gh pr create --web