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 5 commits
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
7 changes: 5 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[our contributing guidelines](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#pull-requests)
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] `UPGRADING.md` has been updated with a migration guide (for breaking changes)

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

- **Does this PR introduce a breaking change?**
<!-- What changes might users need to make in their workflow or application due to this PR? -->
- **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? -->

* **Other information**:
<!-- Any additional information that could help the review process -->
Expand Down
6 changes: 6 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ 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> If the PR contains a breaking change, please start the commit message and PR title with the
string **[breaking]**. Don't forget to describe in the PR description and in the [`UPGRADING.md`][upgrading-file] file
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.
- Write tests for the code you wrote.
- Open your PR against the `master` branch.
- Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult
Expand Down Expand Up @@ -421,3 +426,4 @@ If your PR doesn't need to be included in the changelog, please start the commit
[npm-install-docs]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
[poetry-website]: https://python-poetry.org/
[poetry-docs]: https://python-poetry.org/docs/
[upgrading-file]: ../UPGRADING
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[upgrading-file]: ../UPGRADING
[upgrading-file]: UPGRADING.md

This allows the link to work when viewing the documentation via the GitHub web interface, which is especially likely with CONTRIBUTING.md, since GitHub prompts contributors to read it there.

9 changes: 9 additions & 0 deletions docs/UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Upgrading

Here you can find a list of migration guides to handle breaking changes between releases of the CLI.

For more information about breaking changes see the [contributing documentation][contrib-docs].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the linked information is of interest to the target reader of this file, so I would just remove this sentence.

If it is to be retained, please change the link to be relative:

[contrib-docs]: CONTRIBUTING.md#breaking

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, didn't think about that. I'll just remove it.


## Unreleased

[contrib-docs]: https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[contrib-docs]: https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking

This is no longer needed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I forgot. 🤦

Loading