Skip to content

[skip changelog] Update contributions guidelines and PR template to add labeling and increase focus on breaking changes #1039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 2, 2020
Merged

[skip changelog] Update contributions guidelines and PR template to add labeling and increase focus on breaking changes #1039

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
749ee33
[skip changelog] Update contributions guidelines and PR template to a…
Oct 19, 2020
b1fd6c0
Add better explanation of breaking changes based on suggestions
Nov 5, 2020
edb4bc3
Reword breaking change paragraph in docs and Arduino CLI name in pull…
Nov 5, 2020
8150414
Revert typo
Nov 5, 2020
f38f1d2
[skip changelog] Update breaking changes policy
silvanocerza Dec 2, 2020
d9bcfbf
[skip changelog] Fix some docs issues
silvanocerza Dec 2, 2020
9f7f31c
[skip changelog] Remove unused link from docs
silvanocerza Dec 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reword breaking change paragraph in docs and Arduino CLI name in pull… 
… request template
  • Loading branch information
rsora committed Nov 5, 2020
commit edb4bc3048c39d21f629d41efbf1ca5035288228
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- **Does this PR introduce a breaking change, and is
[titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)?**
<!-- If this PR is merged, will any users need to change their code, command-line invocations, build scripts or data files
when upgrading from an older version of arduino-cli? -->
when upgrading from an older version of Arduino CLI? -->

* **Other information**:
<!-- Any additional information that could help the review process -->
Expand Down
9 changes: 4 additions & 5 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,10 @@ submitting a PR:
- PR titles indirectly become part of the CHANGELOG so it's crucial to provide a good record of **what** change is being
made in the title; **why** it was made will go in the PR description, along with a link to a GitHub issue if it
exists.
- <a id="breaking"></a>A breaking change is a change that forces users to change their code, command-line invocations,
build scripts or data files when upgrading from an older version of arduino-cli. If the PR contains a breaking change,
please start the commit message and PR title with the string **[breaking]**. Don't forget to describe what changes
might users need to make in their workflow or application due to this PR
- Write tests for the code you wrote.
- <a id="breaking"></a> If the PR contains a breaking change, please start the commit message and PR title with the
string **[breaking]**. Don't forget to describe what changes users might need to make in their workflow or application
due to this PR. A breaking change is a change that forces users to change their code, command-line invocations, build
scripts or data files when upgrading from an older version of Arduino CLI.
- Open your PR against the `master` branch.
- Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult
to review and require a lot of work to be merged.
Expand Down