Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 2.42 KB

Contributing Guidelines

The SIG Robotics focuses on technical discussion, API definition, reference architecture, implementation in robots, to enable the cloud ability(storage, AI) to be applied to the robots on edge. We are excited about the prospect of you joining our community. The KubeEdge community abides by the CNCF code of conduct.

  • Open issues for reporting bugs and requesting new features.
  • Contribute to examples to share your problem modeling to others.
  • Contribute to scenarios to provide more meaningful simulation environments.
  • Contribute to configs to provide more meaningful configs for robots/sensors.
  • Contribute to algorithms to enrich robotics algorithm.
  • Contribute to cloud_robotics to make cloud services support for robots.
  • Contribute to backend to make it support more robot-operating systems.
  • Contribute to sensors to make it support more sensors of robot.
  • Contribute to tests to make it more reliable and stable.
  • Contribute to documentation to make it straightforward for everyone.

Notes

  • Check Style

    Please make sure lint your code, and pass the code checking before pull request.

    We have prepared a configuration file for isort and flake8 to lint.

    # Install isort.
pip install isort

# Automatically re-format your imports with isort.
isort --settings-path .github/linters/tox.ini

# Install flake8.
pip install flake8

# Lint with flake8.
flake8 --config .github/linters/tox.ini

# Install editorconfig-checker.
pip install editorconfig-checker

# Lint with editorconfig-checker.
# PATH: Directory or file path of your changes.
editorconfig-checker --config .editorconfig PATH

  • Update Change Log (if needed)