Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 7b886cb

Browse files
author
rsora
committedNov 5, 2020
Add better explanation of breaking changes based on suggestions
1 parent 34b0ca2 commit 7b886cb

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818

1919
- **Does this PR introduce a breaking change, and is
2020
[titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)?**
21-
<!-- What changes might users need to make in their workflow or application due to this PR? -->
21+
<!-- If this PR is merged, will any users need to change their code, command-line invocations, build scripts or data files
22+
when upgrading from an older version of arduino-cli? -->
2223

2324
* **Other information**:
2425
<!-- Any additional information that could help the review process -->

‎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 make changes in their arduino-cli workflow or
58-
client application. If the PR contains a breaking change, please start the commit message and PR title with the string
59-
**[breaking]**. Don't forget to describe what changes might users need to make in their workflow or application due to
60-
this PR
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
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)
Please sign in to comment.