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:41:40 +0000 (08:41 +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)

CONTRIBUTING.md

index e4415538b8458866fb81fd2f3f81873fb85775e6..9f5fe156e37a09c02b08147d37fa76c3e4c9ae8b 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