diff options
| author | Ryan <fauxpark@gmail.com> | 2023-08-05 10:16:10 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-05 10:16:10 +1000 |
| commit | 049a4baec0891db134844f59498add4815e10ddd (patch) | |
| tree | 864b77de6d9f304256bed70fe7312411e0ed0c79 /docs | |
| parent | 37b62606cec1cce42b4c1c0035c72bc021f549d8 (diff) | |
Contributing docs: add note to make sure repo is up to date (#21694)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.md | 1 |
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. |