summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-08-05 00:16:49 +0000
committerQMK Bot <hello@qmk.fm>2023-08-05 00:16:49 +0000
commitbbe58ddb21a1ed9ef64030648385c25830937003 (patch)
tree3629f97dff52736912712c91d5b8fd23a1155926 /docs
parent0b802defd4ad81f38bdd3ae0192e2a834f7d99be (diff)
parent049a4baec0891db134844f59498add4815e10ddd (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index bb46add789..4801bb8224 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -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.