xref: /aosp_15_r20/external/tpm2-tss/CONTRIBUTING.md (revision 758e9fba6fc9adbf15340f70c73baee7b168b1c9)
1*758e9fbaSOystein Eftevaag# Guidelines for submitting bugs:
2*758e9fbaSOystein EftevaagAll non security bugs should be filed on the Issues tracker:
3*758e9fbaSOystein Eftevaaghttps://github.com/tpm2-software/tpm2-tss/issues
4*758e9fbaSOystein Eftevaag
5*758e9fbaSOystein EftevaagSecurity sensitive bugs should be emailed to a maintainer directly, or to Intel
6*758e9fbaSOystein Eftevaagvia the guidelines here:
7*758e9fbaSOystein Eftevaaghttps://security-center.intel.com/VulnerabilityHandlingGuidelines.aspx
8*758e9fbaSOystein Eftevaag
9*758e9fbaSOystein Eftevaag# Guideline for submitting changes:
10*758e9fbaSOystein EftevaagAll changes to the source code must follow the coding standard used in the
11*758e9fbaSOystein Eftevaagsurrounding source and documented [here](doc/coding_standard_c.md).
12*758e9fbaSOystein Eftevaag
13*758e9fbaSOystein EftevaagAll changes should be introduced via github pull requests. This allows anyone to
14*758e9fbaSOystein Eftevaagcomment and provide feedback in lieu of having a mailing list. For pull requests
15*758e9fbaSOystein Eftevaagopened by non-maintainers, any maintainer may review and merge that pull
16*758e9fbaSOystein Eftevaagrequest. For maintainers, they either must have their pull request reviewed by
17*758e9fbaSOystein Eftevaaganother maintainer if possible, or leave the PR open for at least 24 hours, we
18*758e9fbaSOystein Eftevaagconsider this the window for comments.
19*758e9fbaSOystein Eftevaag
20*758e9fbaSOystein Eftevaag## Patch requirements
21*758e9fbaSOystein Eftevaag* All tests must pass on Travis CI for the merge to occur.
22*758e9fbaSOystein Eftevaag* All changes must not introduce superfluous changes or whitespace errors.
23*758e9fbaSOystein Eftevaag* All commits should adhere to the git commit message guidelines described
24*758e9fbaSOystein Eftevaaghere: https://chris.beams.io/posts/git-commit/ with the following exceptions.
25*758e9fbaSOystein Eftevaag * We allow commit subject lines up to 80 characters.
26*758e9fbaSOystein Eftevaag * Commit subject lines should be prefixed with a string identifying the
27*758e9fbaSOystein Eftevaageffected subsystem. If the change is spread over a number of
28*758e9fbaSOystein Eftevaagsubsystems then the prefix may be omitted. Recommended prefix for changes to
29*758e9fbaSOystein Eftevaagfiles in src/tss2-sys is "sys: ", and for changes to files in src/tss2-esys
30*758e9fbaSOystein Eftevaagis "esys: ".
31*758e9fbaSOystein Eftevaag* All contributions must adhere to the Developers Certificate of Origin. The
32*758e9fbaSOystein Eftevaagfull text of the DCO is here: https://developercertificate.org/. Contributors
33*758e9fbaSOystein Eftevaagmust add a 'Signed-off-by' line to their commits. This indicates the
34*758e9fbaSOystein Eftevaagsubmitters acceptance of the DCO.
35*758e9fbaSOystein Eftevaag
36*758e9fbaSOystein Eftevaag## Guideline for merging changes
37*758e9fbaSOystein EftevaagChanges must be merged with the "rebase" option on github to avoid merge commits.
38*758e9fbaSOystein EftevaagThis provides for a clear linear history.
39