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