Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Cem Aksoylar <[email protected]>
  • Loading branch information
petejohanson and caksoylar authored Nov 18, 2024
1 parent 6e54e35 commit 0b5b1af
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs/development/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A "clean" commit history satisfies the following:

- Commit messages follow our [commit message conventions](#commit-messages).
- The sequence of commits should be well organized, with discrete commits used to break any combined work into smaller, cohesive changes if the scope of a given PR/change is larger. This allows for easier code review. You can usually accomplish this by amending (e.g. `git add foo && git commit --amend`) or by interactive rebasing (e.g. `git rebase -i upstream/main`) and squashing/rewording commits.
- Do not use merge commits to catch up with ZMK `main`, instead using rebasing to address any issues with divergence (e.g. `git rebase upstream/main`)
- Do not use merge commits to catch up with ZMK `main`, instead using rebasing to address any issues with divergence (e.g. `git rebase upstream/main`).

### Commit Messages

Expand Down Expand Up @@ -86,7 +86,7 @@ The following scopes are frequently used to further clarify the scope of the cha

## Opening a PR

Create a PR by visiting https://github.com/zmkfirmware/zmk/pulls and clicking "New pull request" and selecting your branch. GitHub should auto-populate a start of a description/body to your PR, but please make sure to supplement that with additional details about the change by completing the sections in the PR template.
Create a PR by visiting https://github.com/zmkfirmware/zmk/pulls and clicking "New pull request" and selecting your branch. GitHub should auto-populate a start of a description/body to your PR, but please make sure to supplement that with additional details about the change and make sure the check-list is complete in the PR template.

Once created, the PR should automatically have reviewers assigned.

Expand Down

0 comments on commit 0b5b1af

Please sign in to comment.