Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 2.15 KB

Contributing to DisplayLink Direct

Thanks for your interest in DisplayLink Direct!

This repository is the public hub for the SDK — its documentation, header files, language bindings, and samples.

License

  • The documentation, samples, and bindings in this repository are covered by the terms in LICENSE.
  • The core libraries are proprietary and closed source. They are distributed as pre-built binaries via GitHub Release Assets and are not part of this repository's source. Third-party components are listed in NOTICE.

By contributing, you agree that your contributions are licensed under the same terms as the content you are modifying.

What contributions are welcome

We welcome:

Please note: because the core libraries are proprietary, we cannot accept code changes to the closed-source core. Bindings and headers track the shipped binaries, so changes there are reviewed on a case-by-case basis.

How to contribute

  1. Open an issue to discuss significant changes before starting work.
  2. Fork the repository and create a branch for your change.
  3. Make your edits and, for documentation changes, preview them locally:
    ./docs/serve.sh
  4. Open a pull request with a clear description of what the change does and why it is needed.

Pull requests for the hosted documentation and samples are especially welcome!

Reporting bugs and requesting features

Use GitHub Issues and include as much detail as possible: the platform, device, SDK version, and steps to reproduce. See the Troubleshooting guide for more information.