Skip to content
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

chore: Update PR template #771

Merged
merged 2 commits into from
Oct 20, 2024
Merged

chore: Update PR template #771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43da1a1
Update PR template
jbeaurivage Oct 18, 2024
cd1c6c3
Remove `cargo login` from `release-crates.yml`
jbeaurivage Oct 18, 2024
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
11 changes: 10 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
[describe your changes here]

# Checklist
- [ ] `CHANGELOG.md` for the BSP or HAL updated
- [ ] All new or modified code is well documented, especially public items
- [ ] No new warnings or clippy suggestions have been introduced - CI will **deny** clippy warnings by default! You may `#[allow]` certain lints where reasonable, but ideally justify those with a short comment.

Expand All @@ -12,3 +11,13 @@

## If Adding a new cargo `feature` to the HAL
- [ ] Feature is added to the test matrix for applicable boards / PACs in `crates.json`

#### Note
The crate changelogs **should no longer** be manually updated! Changelogs are now automatically generated. Instead:

- If your PR is contained to a single crate, or a single feature:
- Nothing else to do; your PR will likely be squashed down to a single commit.
- Please consider using [conventional commmit phrasing](https://www.conventionalcommits.org) in the PR title.
- If your PR brings in large, sweeping changes across multiple crates:
- Organize your commits such that each commit only touches a single crate, or a single feature across multiple crates. Please don't create commits that span multiple features over multiple crates.
- Use [conventional commmits](https://www.conventionalcommits.org) for your commit messages.
3 changes: 0 additions & 3 deletions .github/workflows/release-crates.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@ jobs:
with:
targets: thumbv6m-none-eabi, thumbv7em-none-eabihf

- name: Login to crates.io
run: cargo login ${{ secrets.CRATES_IO_TOKEN }}

- name: Run release-plz
uses: MarcoIeni/[email protected]
env:
Expand Down