A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

94 lines
4.2 KiB

  1. HOW TO CONTRIBUTE TO OpenSSL
  2. ============================
  3. Please visit our [Getting Started] page for other ideas about how to contribute.
  4. [Getting Started]: <https://www.openssl.org/community/getting-started.html>
  5. Development is done on GitHub in the [openssl/openssl] repository.
  6. [openssl/openssl]: <https://github.com/openssl/openssl>
  7. To request new features or report bugs, please open an issue on GitHub
  8. To submit a patch, please open a pull request on GitHub. If you are thinking
  9. of making a large contribution, open an issue for it before starting work,
  10. to get comments from the community. Someone may be already working on
  11. the same thing or there may be reasons why that feature isn't implemented.
  12. To make it easier to review and accept your pull request, please follow these
  13. guidelines:
  14. 1. Anything other than a trivial contribution requires a [Contributor
  15. License Agreement] (CLA), giving us permission to use your code.
  16. If your contribution is too small to require a CLA (e.g. fixing a spelling
  17. mistake), place the text "`CLA: trivial`" on a line by itself separated by
  18. an empty line from the rest of the commit message. It is not sufficient to
  19. only place the text in the GitHub pull request description.
  20. [Contributor License Agreement]: <https://www.openssl.org/policies/cla.html>
  21. To amend a missing "`CLA: trivial`" line after submission, do the following:
  22. ```
  23. git commit --amend
  24. [add the line, save and quit the editor]
  25. git push -f
  26. ```
  27. 2. All source files should start with the following text (with
  28. appropriate comment characters at the start of each line and the
  29. year(s) updated):
  30. ```
  31. Copyright 20xx-20yy The OpenSSL Project Authors. All Rights Reserved.
  32. Licensed under the Apache License 2.0 (the "License"). You may not use
  33. this file except in compliance with the License. You can obtain a copy
  34. in the file LICENSE in the source distribution or at
  35. https://www.openssl.org/source/license.html
  36. ```
  37. 3. Patches should be as current as possible; expect to have to rebase
  38. often. We do not accept merge commits, you will have to remove them
  39. (usually by rebasing) before it will be acceptable.
  40. 4. Patches should follow our [coding style] and compile without warnings.
  41. Where `gcc` or `clang` is available you should use the
  42. `--strict-warnings` `Configure` option. OpenSSL compiles on many varied
  43. platforms: try to ensure you only use portable features. Clean builds via
  44. GitHub Actions and AppVeyor are required, and they are started automatically
  45. whenever a PR is created or updated.
  46. [coding style]: https://www.openssl.org/policies/codingstyle.html
  47. 5. When at all possible, patches should include tests. These can
  48. either be added to an existing test, or completely new. Please see
  49. [test/README.md](test/README.md) for information on the test framework.
  50. 6. New features or changed functionality must include
  51. documentation. Please look at the "pod" files in doc/man[1357] for
  52. examples of our style. Run "make doc-nits" to make sure that your
  53. documentation changes are clean.
  54. 7. For user visible changes (API changes, behaviour changes, ...),
  55. consider adding a note in [CHANGES.md](CHANGES.md).
  56. This could be a summarising description of the change, and could
  57. explain the grander details.
  58. Have a look through existing entries for inspiration.
  59. Please note that this is NOT simply a copy of git-log one-liners.
  60. Also note that security fixes get an entry in [CHANGES.md](CHANGES.md).
  61. This file helps users get more in depth information of what comes
  62. with a specific release without having to sift through the higher
  63. noise ratio in git-log.
  64. 8. For larger or more important user visible changes, as well as
  65. security fixes, please add a line in [NEWS.md](NEWS.md).
  66. On exception, it might be worth adding a multi-line entry (such as
  67. the entry that announces all the types that became opaque with
  68. OpenSSL 1.1.0).
  69. This file helps users get a very quick summary of what comes with a
  70. specific release, to see if an upgrade is worth the effort.
  71. 9. Guidelines how to integrate error output of new crypto library modules
  72. can be found in [crypto/err/README.md](crypto/err/README.md).