diff options
author | Sean V Kelley <seanvk@posteo.de> | 2017-01-22 17:22:05 -0800 |
---|---|---|
committer | Sean V Kelley <seanvk@posteo.de> | 2017-01-22 17:22:05 -0800 |
commit | 4a083a37e91b1a40e9d2bc8fa3c1c6b673b18ae4 (patch) | |
tree | e863a329666c8ab13c1e77fa44039a9baed97388 /CONTRIBUTING.md | |
parent | 05d2d25c16a52d16c3f4cee14bfa4ca8f0209ba9 (diff) | |
download | libva-intel-driver-4a083a37e91b1a40e9d2bc8fa3c1c6b673b18ae4.tar.gz |
intel-vaapi-driver: Add github docs
Adding documentation for the github site.
Signed-off-by: Sean V Kelley <seanvk@posteo.de>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0ff0e647 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,81 @@ +# Contributing to intel-vaapi-driver + +Intel-vaapi-driver is an open source project licensed under the [MIT License] (https://opensource.org/licenses/MIT) + +## Coding Style + +Intel-vaapi-driver does not have a defined coding style at this time, but that will be updated. + +## Certificate of Origin + +In order to get a clear contribution chain of trust we use the [signed-off-by language] (https://01.org/community/signed-process) +used by the Linux kernel project. + +## Patch format + +Beside the signed-off-by footer, we expect each patch to comply with the following format: + +``` +<component>: Change summary + +More detailed explanation of your changes: Why and how. +Wrap it to 72 characters. +See [here] (http://chris.beams.io/posts/git-commit/) +for some more good advices. + +Signed-off-by: <contributor@foo.com> +``` + +For example: + +``` +i965_encoder: remove double check for VAStatus result + +after creating underlying surface there's a double check on the +VAStatus result. Replace it with ASSERT_RET. + +Signed-off-by: Daniel Charles <daniel.charles@intel.com> +Reviewed-by: Sean V Kelley <seanvk@posteo.de> +``` + +## Pull requests + +We accept github pull requests. + +Once you've finished making your changes push them to your fork and send the PR via the github UI. + +## Issue tracking + +If you have a problem, please let us know. IRC is a perfectly fine place +to quickly informally bring something up, if you get a response. The +[mailing list](http://lists.freedesktop.org/mailman/listinfo/libva) +is a more durable communication channel. + +If it's a bug not already documented, by all means please [open an +issue in github](https://github.com/01org/libva/issues/new) so we all get visibility +to the problem and can work towards a resolution. + +For feature requests we're also using github issues, with the label +"enhancement". + +Our github bug/enhancement backlog and work queue are tracked in a +[Libva waffle.io kanban](https://waffle.io/01org/intel-vaapi-driver). + +## Closing issues + +You can either close issues manually by adding the fixing commit SHA1 to the issue +comments or by adding the `Fixes` keyword to your commit message: + +``` +ssntp: test: Add Disconnection role checking tests + +We check that we get the right role from the disconnection +notifier. + +Fixes #121 + +Signed-off-by: Samuel Ortiz <sameo@linux.intel.com> +``` + +Github will then automatically close that issue when parsing the +[commit message](https://help.github.com/articles/closing-issues-via-commit-messages/). |