Skip to content

Commit 2ae69e1

Browse files
author
rsora
committed
[skip changelog] Update contributions guidelines and PR template to add labeling and increase focus on breaking changes
1 parent 4444653 commit 2ae69e1

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* **What is the new behavior?**
1717
<!-- if this is a feature change -->
1818

19-
- **Does this PR introduce a breaking change?**
19+
- **Does this PR introduce a breaking change, and is [labeled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#pull-requests)?**
2020
<!-- What changes might users need to make in their workflow or application due to this PR? -->
2121

2222
* **Other information**:

Diff for: docs/CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ 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+
- Please start the commit message and PR title with the string **[breaking]** if the PR contains a breaking change.
58+
A breaking change is a change that forces users to make changes in their arduino-cli workflow or client application.
5759
- Write tests for the code you wrote.
5860
- Open your PR against the `master` branch.
5961
- Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult

0 commit comments

Comments
 (0)