CONTRIBUTING.md

   1 # Contributing to libva
   2
   3 Libva is an open source project licensed under the [MIT License](https://opensource.org/licenses/MIT)
   4
   5 ## Coding Style
   6
   7 Libva does not have a defined coding style at this time, but that will be updated.
   8
   9 ## Certificate of Origin
  10
  11 In order to get a clear contribution chain of trust we use the [signed-off-by language](https://01.org/community/signed-process)
  12 used by the Linux kernel project.
  13 ## Patch format
  14
  15 Beside the signed-off-by footer, we expect each patch to comply with the following format:
  16
  17 ```
  18 <component>: Change summary
  19
  20 More detailed explanation of your changes: Why and how.
  21 Wrap it to 72 characters.
  22 See [here](http://chris.beams.io/posts/git-commit/)
  23 for some more good advices.
  24
  25 Signed-off-by: <contributor@foo.com>
  26 ```
  27
  28 For example:
  29
  30 ```
  31 drm: remove va_drm_is_authenticated check
  32
  33 If we do not use a render node we must authenticate. Doing the extra
  34 GetClient calls/ioctls does not help much, so don't bother.
  35
  36 Cc: David Herrmann <dh.herrmann@gmail.com>
  37 Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
  38 Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
  39 Reviewed-by: Sean V Kelley <seanvk@posteo.de>
  40 ```
  41
  42 ## Pull requests
  43
  44 We accept github pull requests.
  45
  46 Once you've finished making your changes push them to your fork and send the PR via the github UI.
  47
  48 ## Reporting a security issue
  49
  50 Please mail to secure-opensource@intel.com directly for security issue
  51
  52 ## Public issue tracking
  53
  54 If you have a problem, please let us know.  IRC is a perfectly fine place
  55 to quickly informally bring something up, if you get a response.  The
  56 [mailing list](https://lists.01.org/mailman/listinfo/intel-vaapi-media)
  57 is a more durable communication channel.
  58
  59 If it's a bug not already documented, by all means please [open an
  60 issue in github](https://github.com/intel/libva/issues/new) so we all get visibility
  61 to the problem and can work towards a resolution.
  62
  63 For feature requests we're also using github issues, with the label
  64 "enhancement".
  65
  66 Our github bug/enhancement backlog and work queue are tracked in a
  67 [Libva waffle.io kanban](https://waffle.io/intel/libva).
  68
  69 ## Closing issues
  70
  71 You can either close issues manually by adding the fixing commit SHA1 to the issue
  72 comments or by adding the `Fixes` keyword to your commit message:
  73
  74 ```
  75 ssntp: test: Add Disconnection role checking tests
  76
  77 We check that we get the right role from the disconnection
  78 notifier.
  79
  80 Fixes #121
  81
  82 Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
  83 ```
  84
  85 Github will then automatically close that issue when parsing the
  86 [commit message](https://help.github.com/articles/closing-issues-via-commit-messages/).