Skip to content

Commit

Permalink
Contributing docs: add note to make sure repo is up to date (qmk#21694)
Browse files Browse the repository at this point in the history
  • Loading branch information
fauxpark authored and jesperhellberg committed Aug 8, 2023
1 parent 12f225c commit bc63992
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Most of our style is pretty easy to pick up on. If you are familiar with either

We have a few different types of changes in QMK, each requiring a different level of rigor. We'd like you to keep the following guidelines in mind no matter what type of change you're making.

* **Before you contribute:** Please make sure your fork is up to date with the upstream `qmk_firmware` repo. This will help minimize CI failures that may not occur for you when compiling locally.
* Separate PRs into logical units. For example, do not submit one PR covering two separate features, instead submit a separate PR for each feature.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your code change actually compiles.
Expand Down

0 comments on commit bc63992

Please sign in to comment.