Skip to content

Commit 69e3953

Browse files
Roberto Soraper1234
Roberto Sora
andauthored
Reword breaking change paragraph in docs
Co-authored-by: per1234 <[email protected]>
1 parent 7b886cb commit 69e3953

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ submitting a PR:
5454
- PR titles indirectly become part of the CHANGELOG so it's crucial to provide a good record of **what** change is being
5555
made in the title; **why** it was made will go in the PR description, along with a link to a GitHub issue if it
5656
exists.
57-
- <a id="breaking"></a>A breaking change is a change that forces users to change their code, command-line invocations,
58-
build scripts or data files when upgrading from an older version of arduino-cli. If the PR contains a breaking change,
59-
please start the commit message and PR title with the string **[breaking]**. Don't forget to describe what changes
60-
might users need to make in their workflow or application due to this PR
57+
- <a id="breaking"></a> If the PR contains a breaking change, please start the commit message and PR title with the
58+
string **[breaking]**. Don't forget to describe what changes users might need to make in their workflow or application
59+
due to this PR. A breaking change is a change that forces users to change their code, command-line invocations, build
60+
scripts or data files when upgrading from an older version of Arduino CLI.
6161
- Write tests for the code you wrote.
6262
- Open your PR against the `master` branch.
6363
- Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult

0 commit comments

Comments
 (0)