]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Add 'documentation policy' link to CONTRIBUTING guide.
authorslontis <shane.lontis@oracle.com>
Mon, 18 Mar 2024 00:46:12 +0000 (11:46 +1100)
committerTomas Mraz <tomas@openssl.org>
Thu, 4 Apr 2024 06:42:45 +0000 (08:42 +0200)
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)

CONTRIBUTING.md

index 15490fd9f620d7fcdfe1e295b23453424cdb3dc1..0066e7e8ad8d25a413926cc74983a736323eaf6e 100644 (file)
@@ -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