From 1c745cf56f36a117fcb12a2611918f3e40b26f66 Mon Sep 17 00:00:00 2001 From: Sean V Kelley Date: Sat, 21 Jan 2017 21:40:11 -0800 Subject: [PATCH] Update documentation for github Adding and modifying typical files used on github for documentation. Signed-off-by: Sean V Kelley --- CONTRIBUTING.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 25 +++++++++++++++-- 2 files changed, 106 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d8fd73e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,83 @@ +# Contributing to libva + +Libva is an open source project licensed under the [MIT License] (https://opensource.org/licenses/MIT) + +## Coding Style + +Libva 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: + +``` +: 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: +``` + +For example: + +``` +drm: remove va_drm_is_authenticated check + +If we do not use a render node we must authenticate. Doing the extra +GetClient calls/ioctls does not help much, so don't bother. + +Cc: David Herrmann +Cc: Daniel Vetter +Signed-off-by: Emil Velikov +Reviewed-by: Sean V Kelley +``` + +## 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/libva). + +## 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 +``` + +Github will then automatically close that issue when parsing the +[commit message](https://help.github.com/articles/closing-issues-via-commit-messages/). diff --git a/README.md b/README.md index 9c5100e..41fb60a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# libva -Libva is an implementation for VA-API (VIdeo Acceleration API) +#Libva Project + +Libva is an implementation for VA-API (Video Acceleration API) + +VA-API is an open-source library and API specification, which +provides access to graphics hardware acceleration capabilities +for video processing. It consists of a main library and +driver-specific acceleration backends for each supported hardware +vendor. + +If you would like to contribute to libva, check our [Contributing +guide](https://github.com/01org/libva/blob/master/CONTRIBUTING.md). + +We also recommend taking a look at the ['janitorial' +bugs](https://github.com/01org/libva/issues?q=is%3Aopen+is%3Aissue+label%3AJanitorial) +in our list of open issues as these bugs can be solved without an +extensive knowledge of libva. + +We would love to help you start contributing! + +The libva development team can be reached via our [mailing +list](http://lists.freedesktop.org/mailman/listinfo/libva) and on IRC +in channel #intel-media on [Freenode](https://freenode.net/kb/answer/chat). -- 2.11.0