Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 2.51 KB
Raw

Contributing

Questions

If you have issues with the APIs or have a question about the Watson services, see Stack Overflow.

Issues

If you encounter an issue with the Python SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible somebody has encountered this issue already.

Pull Requests

If you want to contribute to the repository, here's a quick guide:

  1. Fork the repository
  2. Install virtualenv and tox
  3. Develop and test your code changes with pytest.
    • Respect the original code style guide.
    • Only use spaces for indentation.
    • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
    • Check for unnecessary whitespace with git diff --check before committing.
    • Make sure your code supports Python 3.9, 3.10, 3.11. You can use pyenv and tox for this
  4. Make the test pass
  5. Commit your changes
  • Commits should follow the Angular commit message guidelines. This is because our release tool uses this format for determining release versions and generating changelogs. To make this easier, we recommend using the Commitizen CLI with the cz-conventional-changelog adapter.
  1. Push to your fork and submit a pull request to the dev branch

Running the tests

You probably want to set up a virtualenv.

  1. Clone this repository: 
    git clone https://github.com/watson-developer-cloud/python-sdk.git
  2. Install the sdk as an editable package using the current source: 
    pip install --editable .
  3. Install the test dependencies with: 
    pip install -r requirements-dev.txt
  4. Run the test cases with: 
    py.test test

Additional Resources