xref: /aosp_15_r20/external/libva/CONTRIBUTING.md (revision 54e60f844a168e9a219354de272cd517ee8cd4b7)
1# Contributing to libva
2
3Libva is an open source project licensed under the [MIT License](https://opensource.org/licenses/MIT)
4
5## Coding Style
6
7Libva does not have a defined coding style at this time, but that will be updated.
8
9## Certificate of Origin
10
11In order to get a clear contribution chain of trust we use the [signed-off-by language](https://01.org/community/signed-process)
12used by the Linux kernel project.
13## Patch format
14
15Beside the signed-off-by footer, we expect each patch to comply with the following format:
16
17```
18<component>: Change summary
19
20More detailed explanation of your changes: Why and how.
21Wrap it to 72 characters.
22See [here](http://chris.beams.io/posts/git-commit/)
23for some more good advices.
24
25Signed-off-by: <[email protected]>
26```
27
28For example:
29
30```
31drm: remove va_drm_is_authenticated check
32
33If we do not use a render node we must authenticate. Doing the extra
34GetClient calls/ioctls does not help much, so don't bother.
35
36Cc: David Herrmann <[email protected]>
37Cc: Daniel Vetter <[email protected]>
38Signed-off-by: Emil Velikov <[email protected]>
39Reviewed-by: Sean V Kelley <[email protected]>
40```
41
42## Pull requests
43
44We accept github pull requests.
45
46Once you've finished making your changes push them to your fork and send the PR via the github UI.
47
48## Reporting a security issue
49
50Please refer to [security.md](security.md) file for details.
51
52## Public issue tracking
53
54If you have a problem, please let us know.  IRC is a perfectly fine place
55to quickly informally bring something up, if you get a response.  The
56[mailing list](https://lists.01.org/postorius/lists/intel-vaapi-media.lists.01.org)
57is a more durable communication channel.
58
59If it's a bug not already documented, by all means please [open an
60issue in github](https://github.com/intel/libva/issues/new) so we all get visibility
61to the problem and can work towards a resolution.
62
63For feature requests we're also using github issues, with the label
64"enhancement".
65
66Our github bug/enhancement backlog and work queue are tracked in a
67[Libva waffle.io kanban](https://waffle.io/intel/libva).
68
69## Closing issues
70
71You can either close issues manually by adding the fixing commit SHA1 to the issue
72comments or by adding the `Fixes` keyword to your commit message:
73
74```
75ssntp: test: Add Disconnection role checking tests
76
77We check that we get the right role from the disconnection
78notifier.
79
80Fixes #121
81
82Signed-off-by: Samuel Ortiz <[email protected]>
83```
84
85Github will then automatically close that issue when parsing the
86[commit message](https://help.github.com/articles/closing-issues-via-commit-messages/).
87