CONTRIBUTING


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

Patches to intel-gpu-tools are very much welcome, we really want this to be the
universal set of low-level tools and testcases for the Intel kernel gfx driver
on Linux and similar platforms. So please bring on porting patches, bugfixes,
improvements for documentation and new tools and testcases.

A short list of contribution guidelines:

- Please submit patches formatted with git send-email/git format-patch or
  equivalent to

    Intel GFX discussion <intel-gfx@lists.freedesktop.org>

  Please use --subject-prefix="PATCH i-g-t" so that i-g-t patches are easily
  identified in the massive amount mails on intel-gfx. To ensure this is always
  done, autogen.sh will run:

    git config format.subjectprefix "PATCH i-g-t"

  on its first invocation.

- intel-gpu-tools is MIT lincensed and we require contributions to follow the
  developer's certificate of origin: http://developercertificate.org/

- When submitting new testcases please follow the naming conventions documented
  in the generated documentation. Also please make full use of all the helpers and
  convenience macros provided by the igt library. The semantic patch lib/igt.cocci
  can help with the more automatic conversions.

- There is no formal review requirement and regular contributors with commit
  access can push patches right after submitting them to the mailing lists. But
  invasive changes, new helper libraries and contributions from newcomers should
  go through a proper review to ensure overall consistency in the codebase.

- When patches from new contributors (without commit access) are stuck, for
  anything related to the regular releases, issues with packaging and
  integrating platform support or any other intel-gpu-tools issues, please
  contact one of the maintainers (listed in the MAINTAINERS file) and cc the
  intel-gfx mailing list.

- Especially changes to the testcase should get tested on relevant platforms
  before committing. For Intel employees that's best done using PRTS, see the
  relevant internal howtos. Everyone else can just run piglit with i-g-t tests
  locally.

Happy hacking!