Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit d0e904c

Browse files
Roberto Sorasilvanocerza
Roberto Sora
andauthored
[skip changelog] Update contributions guidelines and PR template to add labeling and increase focus on breaking changes (#1039)
* [skip changelog] Update contributions guidelines and PR template to add labeling and increase focus on breaking changes * Add better explanation of breaking changes based on suggestions * Reword breaking change paragraph in docs and Arduino CLI name in pull request template * Revert typo * [skip changelog] Update breaking changes policy * [skip changelog] Fix some docs issues * [skip changelog] Remove unused link from docs Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>
1 parent 95e6835 commit d0e904c

File tree

5 files changed

+18
-2
lines changed

5 files changed

+18
-2
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[our contributing guidelines](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#pull-requests)
77
- [ ] Tests for the changes have been added (for bug fixes / features)
88
- [ ] Docs have been added / updated (for bug fixes / features)
9+
- [ ] `UPGRADING.md` has been updated with a migration guide (for breaking changes)
910

1011
* **What kind of change does this PR introduce?**
1112
<!-- Bug fix, feature, docs update, ... -->
@@ -16,8 +17,10 @@
1617
* **What is the new behavior?**
1718
<!-- if this is a feature change -->
1819

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

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

‎docs/CONTRIBUTING.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ 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> 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 in the PR description and in the [`UPGRADING.md`][upgrading-file] file
59+
what changes users might need to make in their workflow or application due to this PR. A breaking change is a change
60+
that forces users to change their code, command-line invocations, build scripts or data files when upgrading from an
61+
older version of Arduino CLI.
5762
- Write tests for the code you wrote.
5863
- Open your PR against the `master` branch.
5964
- Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult
@@ -421,3 +426,4 @@ If your PR doesn't need to be included in the changelog, please start the commit
421426
[npm-install-docs]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
422427
[poetry-website]: https://python-poetry.org/
423428
[poetry-docs]: https://python-poetry.org/docs/
429+
[upgrading-file]: UPGRADING.md

‎docs/UPGRADING.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Upgrading
2+
3+
Here you can find a list of migration guides to handle breaking changes between releases of the CLI.
4+
5+
## Unreleased

‎docsgen/go.sum‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+o
152152
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
153153
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
154154
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
155+
github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
155156
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
156157
github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw=
157158
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ markdown_extensions:
5858
nav:
5959
- Documentation Home: index.md
6060
- installation.md
61+
- UPGRADING.md
6162
- getting-started.md
6263
- command-line-completion.md
6364
- CONTRIBUTING.md

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /