Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.37 KB

contribute.md

File metadata and controls

65 lines (47 loc) · 3.37 KB
Raw

KINOVA® KORTEX™ API Reference

How to report a bug

Bugs are reported using GitHub issues. Please use the provided template to report a bug - this will help our developers to reproduce the problem.

  • Use a clear and descriptive title for the issue
  • Short description of the issue
  • Provide version numbers of the Kortex API you're using and of the firmware of your Kortex-enabled device. Any other software and version information you think can be useful can be placed here.
  • Steps to reproduce the issue, using a numbered list. Each number corresponds to a single step.
  • An example of code where the problem occurs, to demonstrate the step described above. Code can be pasted in a markdown snippet.
  • Describe the behavior you expected and why
  • Any other information you consider useful, such as screenshots, crash reports and CPU profile captures, as well as your thoughts on what could be the problem.

If your bug doesn't apply to the Kortex API, or you're not able to complete your GitHub issues, please contact us via our website support link.

How to submit a change (e.g. Pull Request)

To create a pull request please refer to the GitHub help page: Creating a pull request

Any pull request that doesn't have enough information or can't be easily reviewed will be rejected by Kinova. To make sure your pull request isn't rejected, please complete and include the following list in your pull request description.

  • Identify the bug/feature you are implementing
  • Description of change
  • Possible drawbacks
  • Release Notes
  • Any other information you find is useful

Any submitted pull request can be merged, reworked, declined or deleted by Kinova at any time without advance notice

How to submit an enhancement request

Enhancement requests use the GitHub Feature Request. You have to follow the provided templates to submit an enhancement request. This will help the developers to implement the new feature. Here are the main sections of the provided template.

  • Summary, A short description of the requested feature.
  • Use cases, Why is this feature needed? What are the use cases covered by the feature?
  • Alternative, Do you have an idea how on how best to implement this enhancement? If this feature is not implemented, do you have a workaround?
  • Possible issues, Anything that could be affected by the new feature.
  • Additional content, Any other information you would like us to know about the requested enhancement.