Skip to content
  • Bob Beck's avatar
    b3020646
    Modernize and update STYLE.MD, add DOCUMENTATION.MD · b3020646
    Bob Beck authored
    
    
    So this repatriates DOCUMENTATION.MD from the web page to the
    code base, and links both STYLE.MD and DOCUMENTATION.MD from
    CONTRIBUTING.MD
    
    It does a large rototilling of STYLE.MD to address many of the
    outstanding concerns noted when I started this before clang-format
    last year, and brings us roughly in line with the things that are
    addressed in similar style guides for other projects.
    
    Most of the changed or updated reccomendations reflect what we
    currently have been doing, or have expressed as a desire to
    move to in the future.
    
    Most larger "OpenSSL-isms" I've tried to explicitly call out
    to make this a more cohesive and useful guide for a new contributor
    
    Reviewed-by: default avatarNeil Horman <nhorman@openssl.org>
    Reviewed-by: default avatarMilan Broz <mbroz@openssl.org>
    MergeDate: Fri Jul 10 15:37:16 2026
    (Merged from https://github.com/openssl/openssl/pull/29295)
    b3020646
    Modernize and update STYLE.MD, add DOCUMENTATION.MD
    Bob Beck authored
    
    
    So this repatriates DOCUMENTATION.MD from the web page to the
    code base, and links both STYLE.MD and DOCUMENTATION.MD from
    CONTRIBUTING.MD
    
    It does a large rototilling of STYLE.MD to address many of the
    outstanding concerns noted when I started this before clang-format
    last year, and brings us roughly in line with the things that are
    addressed in similar style guides for other projects.
    
    Most of the changed or updated reccomendations reflect what we
    currently have been doing, or have expressed as a desire to
    move to in the future.
    
    Most larger "OpenSSL-isms" I've tried to explicitly call out
    to make this a more cohesive and useful guide for a new contributor
    
    Reviewed-by: default avatarNeil Horman <nhorman@openssl.org>
    Reviewed-by: default avatarMilan Broz <mbroz@openssl.org>
    MergeDate: Fri Jul 10 15:37:16 2026
    (Merged from https://github.com/openssl/openssl/pull/29295)
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
Loading