summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorNicola Tuveri <nic.tuv@gmail.com>2020-04-24 19:25:56 +0300
committerNicola Tuveri <nic.tuv@gmail.com>2020-04-27 16:35:39 +0300
commitee6c7cde752992f0fb63820a2c5e63496fd686b1 (patch)
treed0c0b4219d46f05b8c306addfe5b8843cddc73f3 /CONTRIBUTING.md
parent70411a50d4b207e6d0352c12588e93c0c206ca39 (diff)
Fix links in CONTRIBUTING.md
CHANGES and NEWS were renamed into CHANGES.md and NEWS.md; this commit updates the references inside CONTRIBUTING.md to fix broken links. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11634)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0585cf4371..7a9fa2b4ec 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -70,18 +70,20 @@ guidelines:
documentation changes are clean.
7. For user visible changes (API changes, behaviour changes, ...),
- consider adding a note in [CHANGES](CHANGES). This could be a summarising
- description of the change, and could explain the grander details.
+ consider adding a note in [CHANGES.md](CHANGES.md).
+ This could be a summarising description of the change, and could
+ explain the grander details.
Have a look through existing entries for inspiration.
Please note that this is NOT simply a copy of git-log one-liners.
- Also note that security fixes get an entry in CHANGES.
+ Also note that security fixes get an entry in CHANGES.md.
This file helps users get more in depth information of what comes
with a specific release without having to sift through the higher
noise ratio in git-log.
8. For larger or more important user visible changes, as well as
- security fixes, please add a line in [NEWS](NEWS). On exception, it might be
- worth adding a multi-line entry (such as the entry that announces all
- the types that became opaque with OpenSSL 1.1.0).
+ security fixes, please add a line in [NEWS.md](NEWS.md).
+ On exception, it might be worth adding a multi-line entry (such as
+ the entry that announces all the types that became opaque with
+ OpenSSL 1.1.0).
This file helps users get a very quick summary of what comes with a
specific release, to see if an upgrade is worth the effort.