Contributing to the Xilinx Video SDK¶
Thank you for your interest in contributing to the Xilinx Video SDK project. Whether it’s a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
You can report bugs and feature requests
You can send patches to update the documentation, the tutorials and the examples included in the in the Xilinx Video SDK
You can send patches which add new features or fix bugs to the various packages included in the Xilinx Video SDK
Reporting Bugs and Feature Requests¶
Please use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn’t already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
A reproducible test case or series of steps
The version of the Xilinx Video SDK which is being used
Any modifications you’ve made relevant to the bug
Anything unusual about your environment or deployment
Contributing via Pull Requests¶
Please use GitHub Pull Requests (PR) for sending code contributions. When sending code, sign your work as described below. Be sure to use the same license for your contributions as the current license of the Xilinx Video SDK component you are contributing to.
Contributions via pull requests are much appreciated. Before sending us a pull request, please follow these general guidelines:
Check existing open, and recently merged, pull requests to make sure someone else hasn’t addressed the problem already
The .rst source code for the HTML documentation is maintained on the
gh-pagesbranch of the repository
If editing the documentation, build the HTML output (as explained in the
Open an issue to discuss any significant work
Focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change
Commit to your fork using clear commit messages
Sign your work as described below
Sign Your Work¶
Please use the Signed-off-by line at the end of your patch which indicates that you accept the Developer Certificate of Origin (DCO) defined by https://developercertificate.org/ reproduced below:
Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Here is an example Signed-off-by line which indicates that the contributor accepts DCO:
This is my commit message Signed-off-by: Jane Doe <firstname.lastname@example.org>
All Xilinx Video SDK code is licensed under the terms of the license (LICENSE.top). Your contribution will be accepted under the same license of the Xilinx Video SDK component which you are contributing to.