Skip to content

Latest commit

 

History

History
32 lines (27 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

32 lines (27 loc) · 1.82 KB
Raw

Questions

If you are having problems using the APIs or have a question about IBM Cloud services, please ask a question at or Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

General Information

For general guidance on contributing to this project, please see this link

Prerequisites

The following tools are required in order to build this project:

  • Git
  • A modern version of the make utility.
    Note: Windows users will likely need to install one of the various make utilities available for Windows.
  • A version of Python that is >= the minimum version supported by the project.
    Note: It is highly recommended that you use Python's venv module to create a virtual environment for your project. This will allow you to work on this project (including the installation of any project dependencies) without affecting your computer's Python installation or any other Python projects on your computer. More details are available here.

Windows users might find it more convenient to use Windows Subsystem for Linux (WSL) or Cygwin when making contributions to this project.

Updating an existing service within the SDK

For instructions on updating an existing service within the SDK, please see update_service.md