Skip to content

Commit 6eb3dfa

Browse files
committed
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.
1 parent 9bdca8b commit 6eb3dfa

File tree

1 file changed

+0
-2
lines changed

1 file changed

+0
-2
lines changed

Diff for: docs/CONTRIBUTING.md

-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,6 @@ submitting a PR:
5858
- Maintain [**clean commit history**](http://www.freshconsulting.com/atomic-commits) and use
5959
[**meaningful commit messages**](http://chris.beams.io/posts/git-commit). PRs with messy commit history are difficult
6060
to review and require a lot of work to be merged.
61-
- If your PR doesn't need to be included in the changelog, please start the commit message and PR title with the string
62-
**[skip changelog]**
6361
- <a id="breaking"></a> If the PR contains a breaking change, please start the commit message and PR title with the
6462
string **[breaking]**. Don't forget to describe in the PR description what changes users might need to make in their
6563
workflow or application due to this PR. A breaking change is a change that forces users to change their command-line

0 commit comments

Comments
 (0)