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