CONTRIBUTING.md

Contributing to libva

Libva is an open source project licensed under the MIT License

Coding Style

We follow the Linux coding style with a few changes in libva. You may run 'astyle --style=linux -cnpUH -s4 -M120 ' to format/indent a single file or run './style_unify' in the top-level directory to handle all .c/.h/.cpp files in libva.

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 the coding style.

For example:

Checking coding style...

--- .merge_file_2VbdKc  2017-04-07 20:04:51.969577559 +0800
+++ /tmp/.merge_file_2VbdKc.B57 2017-04-07 20:04:52.054578126 +0800
@@ -64,8 +64,7 @@ int va_parseConfig(char *env, char *env_
         return 1;

     fp = fopen("/etc/libva.conf", "r");
-    while (fp && (fgets(oneline, 1024, fp) != NULL))
-    {
+    while (fp && (fgets(oneline, 1024, fp) != NULL)) {
         if (strlen(oneline) == 1)
             continue;
         token = strtok_r(oneline, "=\n", &saveptr);

**************************************************************************
 Coding style error in va/va.c

 Please fix the coding style before committing. You may run the command
 below to fix the coding style from the top-level directory

 astyle --style=linux -cnpUH -s4 -M120 va/va.c
**************************************************************************

Certificate of Origin

In order to get a clear contribution chain of trust we use the signed-off-by language 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:

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 <dh.herrmann@gmail.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.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 is a more durable communication channel.

If it's a bug not already documented, by all means please open an issue in github 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.

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.