CONTRIBUTING.md

   1 # Contributing to intel-vaapi-driver
   2
   3 Intel-vaapi-driver is an open source project licensed under the [MIT License] (https://opensource.org/licenses/MIT)
   4
   5 ## Coding Style
   6
   7 Intel-vaapi-driver 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
  14 ## Patch format
  15
  16 Beside the signed-off-by footer, we expect each patch to comply with the following format:
  17
  18 ```
  19 <component>: Change summary
  20
  21 More detailed explanation of your changes: Why and how.
  22 Wrap it to 72 characters.
  23 See [here] (http://chris.beams.io/posts/git-commit/)
  24 for some more good advices.
  25
  26 Signed-off-by: <contributor@foo.com>
  27 ```
  28
  29 For example:
  30
  31 ```
  32 i965_encoder: remove double check for VAStatus result
  33
  34 after creating underlying surface there's a double check on the
  35 VAStatus result. Replace it with ASSERT_RET.
  36
  37 Signed-off-by: Daniel Charles <daniel.charles@intel.com>
  38 Reviewed-by: Sean V Kelley <seanvk@posteo.de>
  39 ```
  40
  41 ## Pull requests
  42
  43 We accept github pull requests.
  44
  45 Once you've finished making your changes push them to your fork and send the PR via the github UI.
  46
  47 ## Issue tracking
  48
  49 If you have a problem, please let us know.  IRC is a perfectly fine place
  50 to quickly informally bring something up, if you get a response.  The
  51 [mailing list](https://lists.01.org/mailman/listinfo/intel-vaapi-media)
  52 is a more durable communication channel.
  53
  54 If it's a bug not already documented, by all means please [open an
  55 issue in github](https://github.com/01org/intel-vaapi-driver/issues/new) so we all get visibility
  56 to the problem and can work towards a resolution.
  57
  58 For feature requests we're also using github issues, with the label
  59 "enhancement".
  60
  61 Our github bug/enhancement backlog and work queue are tracked in a
  62 [Intel vaapi driver waffle.io kanban](https://waffle.io/01org/intel-vaapi-driver).
  63
  64 ## Closing issues
  65
  66 You can either close issues manually by adding the fixing commit SHA1 to the issue
  67 comments or by adding the `Fixes` keyword to your commit message:
  68
  69 ```
  70 ssntp: test: Add Disconnection role checking tests
  71
  72 We check that we get the right role from the disconnection
  73 notifier.
  74
  75 Fixes #121
  76
  77 Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
  78 ```
  79
  80 Github will then automatically close that issue when parsing the
  81 [commit message](https://help.github.com/articles/closing-issues-via-commit-messages/).