aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2021-10-05 20:29:52 +1100
committerGitHub <noreply@github.com>2021-10-05 20:29:52 +1100
commit7a49e5d2078e8e1044f11d0d7d2a67e82867024a (patch)
treef886dd0dfa4287333ba5eacf5c470eb23f86990b
parent46fe8ab4e28182418a639b92490d6c5ca30897ef (diff)
downloadqmk_firmware-7a49e5d2078e8e1044f11d0d7d2a67e82867024a.tar.gz
qmk_firmware-7a49e5d2078e8e1044f11d0d7d2a67e82867024a.zip
Add clarification for licensing. (#14704)
* Add clarification for licensing. * Errr, v2.
-rw-r--r--docs/pr_checklist.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
index c8e27d565..cac3312e0 100644
--- a/docs/pr_checklist.md
+++ b/docs/pr_checklist.md
@@ -15,7 +15,9 @@ If there are any inconsistencies with these recommendations, you're best off [cr
15 - a board designer naming their keyboard with uppercase letters is not enough justification 15 - a board designer naming their keyboard with uppercase letters is not enough justification
16- valid license headers on all `*.c` and `*.h` source files 16- valid license headers on all `*.c` and `*.h` source files
17 - GPL2/GPL3 recommended for consistency 17 - GPL2/GPL3 recommended for consistency
18 - an example GPL2+ license header may be copied and modified from the bottom of this document
18 - other licenses are permitted, however they must be GPL-compatible and must allow for redistribution. Using a different license will almost certainly delay a PR getting merged. 19 - other licenses are permitted, however they must be GPL-compatible and must allow for redistribution. Using a different license will almost certainly delay a PR getting merged.
20 - missing license headers will prevent PR merge due to ambiguity with license compatibility
19- QMK Codebase "best practices" followed 21- QMK Codebase "best practices" followed
20 - this is not an exhaustive list, and will likely get amended as time goes by 22 - this is not an exhaustive list, and will likely get amended as time goes by
21 - `#pragma once` instead of `#ifndef` include guards in header files 23 - `#pragma once` instead of `#ifndef` include guards in header files
@@ -137,3 +139,23 @@ Thanks for contributing!
137In general, we want to see two (or more) approvals that are meaningful (e.g. that have inspected code) before a PR will be considered for merge. These reviews are not limited to collaborators -- any community member willing to put in the time is welcomed (and encouraged). The only difference is that your checkmark won't be green, and that's fine! 139In general, we want to see two (or more) approvals that are meaningful (e.g. that have inspected code) before a PR will be considered for merge. These reviews are not limited to collaborators -- any community member willing to put in the time is welcomed (and encouraged). The only difference is that your checkmark won't be green, and that's fine!
138 140
139Additionally, PR reviews are something that is done in our free time. We are not paid nor compensated for the time we spend reviewing, as it is a labor of love. As such, this means that it can take time for us to get to your Pull Request. Things like family, or life can get in the way of us getting to PRs, and burnout is a serious concern. The QMK firmware repository averages 200 PRs opened and 200 PRs merged every month, so please have patience. 141Additionally, PR reviews are something that is done in our free time. We are not paid nor compensated for the time we spend reviewing, as it is a labor of love. As such, this means that it can take time for us to get to your Pull Request. Things like family, or life can get in the way of us getting to PRs, and burnout is a serious concern. The QMK firmware repository averages 200 PRs opened and 200 PRs merged every month, so please have patience.
142
143## Example GPLv2 Header
144
145```
146/* Copyright 2021 Your Name (@yourgithub)
147 *
148 * This program is free software: you can redistribute it and/or modify
149 * it under the terms of the GNU General Public License as published by
150 * the Free Software Foundation, either version 2 of the License, or
151 * (at your option) any later version.
152 *
153 * This program is distributed in the hope that it will be useful,
154 * but WITHOUT ANY WARRANTY; without even the implied warranty of
155 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
156 * GNU General Public License for more details.
157 *
158 * You should have received a copy of the GNU General Public License
159 * along with this program. If not, see <http://www.gnu.org/licenses/>.
160 */
161```