From 86a83c1ec5ba2a6e5130a373fca394a7002060c7 Mon Sep 17 00:00:00 2001 From: NRK Date: Mon, 27 Jun 2022 21:20:59 +0200 Subject: CHANGELOG: use reference style links (#325) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Originally we stopped doing links in the CHANGELOG since it harmed readability when reading the raw markdown file. However we can use reference styles links instead. * Pros - Doesn't harm readability. - We can link to proper thread on the proper repo (`CodeBerg/nsxiv` for newer threads, `nsxiv-record` for wiped ones) - The links will be clickable on the [webpage] - Both GitHub and Codeberg support reference style links, as well as lowdown (which we use for building the webpage) [webpage]: https://nsxiv.codeberg.page/changelog/ * Cons - Slightly higher maintainance burden. - Larger file size. Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/325 Reviewed-by: Berke Kocaoğlu --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82c4a75..93e0552 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,8 @@ For releases, the process is the following: changes which never made it into a release. * Use the "Changes" section to document behavior changes since the last release, the "Added" section for new features, and the "Fixes" section - for fixed bugs or regressions. Include pull request IDs. + for fixed bugs or regressions. + * Include pull request IDs with reference style links. Mirroring to GitHub: -- cgit v1.2.3-54-g00ecf