From 6eb3dfa2a52c6936118d31c2fa893fd17a4ea047 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 1 Jul 2021 10:41:50 -0700 Subject: [PATCH] Rescind policy that commits should start with "[skip changelog]" The raw release changelog is generated from the commit messages. The `arduino/create-changelog` action is configured to omit any commit message that is prefixed with "[skip changelog]". After extensive use of this approach in the Arduino CLI repository, my conclusion is that it provides a miniscule time savings for the release manager at the cost of massive pollution of the valuable commit history and a significantly less contributor friendly repository. For this reason, I have never employed this practice in my work on Arduino Lint and I do not want contributors to do so either. --- docs/CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8ee4b5e7..5c7eee61 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -58,8 +58,6 @@ submitting a PR: - Maintain [**clean commit history**](http://www.freshconsulting.com/atomic-commits) and use [**meaningful commit messages**](http://chris.beams.io/posts/git-commit). PRs with messy commit history are difficult to review and require a lot of work to be merged. -- If your PR doesn't need to be included in the changelog, please start the commit message and PR title with the string - **[skip changelog]** - If the PR contains a breaking change, please start the commit message and PR title with the string **[breaking]**. Don't forget to describe in the PR description what changes users might need to make in their workflow or application due to this PR. A breaking change is a change that forces users to change their command-line