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 In our project we follow the Linux coding style with a few changes. You may run 'astyle --style=linux -cnpUH -s4 -M120 <file>'
   8 to format/indent a single file or run './style_unify' in the top-level directory to handle all .c/.h files in the src directory.
   9
  10 You will fail to commit your patch if your patch doesn't follow the coding style and the pre-commit hook will prompt you to fix
  11 the coding style.
  12
  13 For example:
  14
  15 ```
  16 Checking coding style...
  17
  18 --- .merge_file_tZMQ4C  2017-03-31 11:02:36.244617415 +0800
  19 +++ /tmp/.merge_file_tZMQ4C.D0V 2017-03-31 11:02:36.274617276 +0800
  20 @@ -438,8 +438,7 @@ intel_batchbuffer_align(struct intel_bat
  21      assert((pad_size & 3) == 0);
  22      assert(intel_batchbuffer_space(batch) >= pad_size);
  23
  24 -    while (pad_size >= 4)
  25 -    {
  26 +    while (pad_size >= 4) {
  27          intel_batchbuffer_emit_dword(batch, 0);
  28          pad_size -= 4;
  29      }
  30
  31 **************************************************************************
  32  Coding style error in src/intel_batchbuffer.c
  33
  34  Please fix the coding style before committing. You may run the command
  35  below to fix the coding style from the top-level directory
  36
  37  astyle --style=linux -cnpUH -s4 -M120 src/intel_batchbuffer.c
  38 **************************************************************************
  39 ```
  40
  41 ## Certificate of Origin
  42
  43 In order to get a clear contribution chain of trust we use the [signed-off-by language] (https://01.org/community/signed-process)
  44 used by the Linux kernel project.
  45
  46 ## Patch format
  47
  48 Beside the signed-off-by footer, we expect each patch to comply with the following format:
  49
  50 ```
  51 <component>: Change summary
  52
  53 More detailed explanation of your changes: Why and how.
  54 Wrap it to 72 characters.
  55 See [here] (http://chris.beams.io/posts/git-commit/)
  56 for some more good advices.
  57
  58 Signed-off-by: <contributor@foo.com>
  59 ```
  60
  61 For example:
  62
  63 ```
  64 i965_encoder: remove double check for VAStatus result
  65
  66 after creating underlying surface there's a double check on the
  67 VAStatus result. Replace it with ASSERT_RET.
  68
  69 Signed-off-by: Daniel Charles <daniel.charles@intel.com>
  70 Reviewed-by: Sean V Kelley <seanvk@posteo.de>
  71 ```
  72
  73 ## Pull requests
  74
  75 We accept github pull requests.
  76
  77 Once you've finished making your changes push them to your fork and send the PR via the github UI.
  78
  79 ## Reporting a security issue
  80
  81 Please mail to secure-opensource@intel.com directly for security issue
  82
  83 ## Public issue tracking
  84
  85 If you have a problem, please let us know.  IRC is a perfectly fine place
  86 to quickly informally bring something up, if you get a response.  The
  87 [mailing list](https://lists.01.org/mailman/listinfo/intel-vaapi-media)
  88 is a more durable communication channel.
  89
  90 If it's a bug not already documented, by all means please [open an
  91 issue in github](https://github.com/intel/intel-vaapi-driver/issues/new) so we all get visibility
  92 to the problem and can work towards a resolution.
  93
  94 For feature requests we're also using github issues, with the label
  95 "enhancement".
  96
  97 Our github bug/enhancement backlog and work queue are tracked in a
  98 [Intel vaapi driver waffle.io kanban](https://waffle.io/intel/intel-vaapi-driver).
  99
 100 ## Closing issues
 101
 102 You can either close issues manually by adding the fixing commit SHA1 to the issue
 103 comments or by adding the `Fixes` keyword to your commit message:
 104
 105 ```
 106 ssntp: test: Add Disconnection role checking tests
 107
 108 We check that we get the right role from the disconnection
 109 notifier.
 110
 111 Fixes #121
 112
 113 Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
 114 ```
 115
 116 Github will then automatically close that issue when parsing the
 117 [commit message](https://help.github.com/articles/closing-issues-via-commit-messages/).