diff options
| author | NRK <nrk@disroot.org> | 2022-06-27 21:20:59 +0200 |
|---|---|---|
| committer | NRK <nrk@disroot.org> | 2022-06-27 21:20:59 +0200 |
| commit | 86a83c1ec5ba2a6e5130a373fca394a7002060c7 (patch) | |
| tree | 117088cf3d321950b5304ae078f58a454a714b3a /CONTRIBUTING.md | |
| parent | f78626c1879c0cd4ce590e145ed804c02bfa6d9b (diff) | |
| download | nsxiv-86a83c1ec5ba2a6e5130a373fca394a7002060c7.tar.zst | |
CHANGELOG: use reference style links (#325)
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 <berke.kocaoglu@metu.edu.tr>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 2 insertions, 1 deletions
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: |