CONTRIBUTING 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. HOW TO CONTRIBUTE TO PATCHES OpenSSL
  2. ------------------------------------
  3. (Please visit https://openssl.org/community/getting-started.html for
  4. other ideas about how to contribute.)
  5. Development is coordinated on the openssl-dev mailing list (see the
  6. above link or http://mta.openssl.org for information on subscribing).
  7. If you are unsure as to whether a feature will be useful for the general
  8. OpenSSL community you might want to discuss it on the openssl-dev mailing
  9. list first. Someone may be already working on the same thing or there
  10. may be a good reason as to why that feature isn't implemented.
  11. The best way to submit a patch is to make a pull request on GitHub.
  12. (It is not necessary to send mail to rt@openssl.org to open a ticket!)
  13. If you think the patch could use feedback from the community, please
  14. start a thread on openssl-dev.
  15. You can also submit patches by sending it as mail to rt@opensslorg.
  16. Please include the word "PATCH" and an explanation of what the patch
  17. does in the subject line. If you do this, our preferred format is "git
  18. format-patch" output. For example to provide a patch file containing the
  19. last commit in your local git repository use the following command:
  20. % git format-patch --stdout HEAD^ >mydiffs.patch
  21. Another method of creating an acceptable patch file without using git is as
  22. follows:
  23. % cd openssl-work
  24. ...make your changes...
  25. % ./Configure dist; make clean
  26. % cd ..
  27. % diff -ur openssl-orig openssl-work >mydiffs.patch
  28. Note that pull requests are generally easier for the team, and community, to
  29. work with. Pull requests benefit from all of the standard GitHub features,
  30. including code review tools, simpler integration, and CI build support.
  31. No matter how a patch is submitted, the following items will help make
  32. the acceptance and review process faster:
  33. 1. Anything other than trivial contributions will require a contributor
  34. licensing agreement, giving us permission to use your code. See
  35. https://openssl.org/policies/cla.html for details.
  36. 2. All source files should start with the following text (with
  37. appropriate comment characters at the start of each line and the
  38. year(s) updated):
  39. Copyright 20xx-20yy The OpenSSL Project Authors. All Rights Reserved.
  40. Licensed under the OpenSSL license (the "License"). You may not use
  41. this file except in compliance with the License. You can obtain a copy
  42. in the file LICENSE in the source distribution or at
  43. https://www.openssl.org/source/license.html
  44. 3. Patches should be as current as possible. When using GitHub, please
  45. expect to have to rebase and update often.
  46. 3. Patches should follow our coding style (see
  47. https://www.openssl.org/policies/codingstyle.html) and compile without
  48. warnings using the --strict-warnings flag. OpenSSL compiles on many
  49. varied platforms: try to ensure you only use portable features.
  50. 4. When at all possible, patches should include tests. These can either be
  51. added to an existing test, or completely new. Please see test/README
  52. for information on the test framework.