README.md

   1 drm\_hwcomposer
   2 ======
   3
   4 Patches to drm\_hwcomposer are very much welcome, we really want this to be the
   5 universal HW composer implementation for Android and similar platforms. So
   6 please bring on porting patches, bugfixes, improvements for documentation and
   7 new features.
   8
   9 A short list of contribution guidelines:
  10 * Submit changes via gitlab merge requests on gitlab.freedesktop.org.
  11 * drm\_hwcomposer is Apache 2.0 Licensed and we require contributions to follow
  12   the developer's certificate of origin: http://developercertificate.org/.
  13 * When submitting new code please follow the naming conventions documented in
  14   the generated documentation. Also please make full use of all the helpers and
  15   convenience macros provided by drm\_hwcomposer. The below command can help
  16   you with formatting of your patches:
  17
  18     ```
  19     git diff | clang-format-diff-12 -p 1 -style=file
  20     ```
  21
  22 * Hardware specific changes should be tested on relevant platforms before
  23   committing.
  24
  25 If you need inspiration, please checkout our [TODO issues][1].
  26
  27 Happy hacking!
  28
  29 [1]: https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer/issues?label_name%5B%5D=TODO