From 0b5b1af1b5e9b7ede2e039e20ae1fe9db7dc4cb2 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Mon, 18 Nov 2024 16:23:53 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Cem Aksoylar --- docs/docs/development/contributing/pull-requests.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/development/contributing/pull-requests.md b/docs/docs/development/contributing/pull-requests.md index fba53d658942..8890d2d6f3e0 100644 --- a/docs/docs/development/contributing/pull-requests.md +++ b/docs/docs/development/contributing/pull-requests.md @@ -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 @@ -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.