From 0a22dcc044929e1d399b5749730d8c7923a54795 Mon Sep 17 00:00:00 2001 From: sharkdp Date: Tue, 1 Dec 2020 19:38:05 +0100 Subject: [PATCH] Add CHANGELOG section to CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ef632e..8a2313e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,24 @@ We welcome any form of contribution: **Note**: Before you take the time to open a pull request, please open a ticket first. This will give us the chance to discuss any potential changes first. +## Add an entry to the changelog + +If your contribution changes the behavior of `fd` (as opposed to a typo-fix +in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file +and describe your changes. This makes the release process much easier and +therefore helps to get your changes into a new `fd` release faster. + +The top of the `CHANGELOG` contains a *"unreleased"* section with a few +subsections (Features, Bugfixes, …). Please add your entry to the subsection +that best describes your change. + +Entries follow this format: +``` +- Short description of what has been changed, see #123 (@user) +``` +Here, `#123` is the number of the original issue and/or your pull request. +Please replace `@user` by your GitHub username. + ## Important links * [Open issues](https://github.com/sharkdp/fd/issues)