Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 2.95 KB

Contributing to UHD

Reporting Bugs and other Issues

Please don't use the bug/issue tracker to ask questions. If you have questions, please ask on the usrp-users mailing list, or email [email protected]!

If you have found an issue or bug in UHD, you can use the GitHub issue tracker to submit a report. Please be as specific as possible, and use the issue template, it will be easier for us to debug an issue if we have all the information it asks for.

Before you submit a bug report, please make sure the issue you're experiencing is not already solved. The following resources might help you fix your issue:

Also, please confirm there's no other issue already open which describes your issue.

How to submit a bug report

When submitting a bug report, please provide all the information required to reproduce the issue, such as:

  • Exact UHD version (git hash, if you can)
  • Which devices you're seeing this problem on
  • How are the devices connected (network, PCIe, clocking, RF, ...)

Most importantly, provide a command or program that we can run to reproduce the issue. The examples shipped with UHD are good starting points. Remember that the issue tracker on GitHub is public, so don't post any sensitive or classified information there.

Code Contributions

If you are interested in submitting bug fixes or enhancements, please read the following sections. Please note that we will reserve the right to reject any kind of submission. Therefore, we advise getting in touch with us before doing major work.

Legal Notes

All code in this repository, unless specified otherwise, is copyright of Ettus Research / National Instruments. For any non-trivial contribution, we require a signed Contributor License Agreement (CLA) for every developer submitting code to assign copyright of contributions over to Ettus Research / National Instruments.

Small changes (less than 10 lines of code), or documentation fixes, may be accepted without prior submission of a CLA. This decision is made by Ettus Research / National Instruments.

Coding Guidelines

The following guidelines apply: