diff options
| author | slontis <shane.lontis@oracle.com> | 2024-03-18 11:46:12 +1100 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2024-04-04 08:42:13 +0200 |
| commit | 6a2202706bf8af83abbf1130fe49af1b063800a6 (patch) | |
| tree | 2f172d246f1a52cd1b5f5cc5db4356221c0f81a1 | |
| parent | 6912e07c95e91f51f13bc1971aba0f0a8e3fcc02 (diff) | |
Add 'documentation policy' link to CONTRIBUTING guide.
Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/23875)
(cherry picked from commit e817766c0f46f371fabe344fba60d13afcfc3da9)
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4415538b8..9f5fe156e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,7 +67,8 @@ guidelines: often. We do not accept merge commits, you will have to remove them (usually by rebasing) before it will be acceptable. - 4. Code provided should follow our [coding style] and compile without warnings. + 4. Code provided should follow our [coding style] and [documentation policy] + and compile without warnings. There is a [Perl tool](util/check-format.pl) that helps finding code formatting mistakes and other coding style nits. Where `gcc` or `clang` is available, you should use the @@ -77,6 +78,7 @@ guidelines: whenever a PR is created or updated by committers. [coding style]: https://www.openssl.org/policies/technical/coding-style.html + [documentation policy]: https://openssl.org/policies/technical/documentation-policy.html 5. When at all possible, code contributions should include tests. These can either be added to an existing test, or completely new. Please see |