diff options
author | innovaker <66737976+innovaker@users.noreply.github.com> | 2020-11-12 12:18:45 +0000 |
---|---|---|
committer | Pete Johanson <peter@peterjohanson.com> | 2020-11-20 22:31:56 -0500 |
commit | 532c1987b2b464053d5e85c71a775e83e758c1e7 (patch) | |
tree | 36345237a4bb814ed0fc4b68e5a324f302c4cddc /docs/docs/development/clean-room.md | |
parent | b6e63683d48d14af07da34ed60cc2389f26ea64a (diff) |
refactor(docs): Move `dev-` documents into `/development`
Aligns to conventions introduced by newer documentation.
Diffstat (limited to 'docs/docs/development/clean-room.md')
-rw-r--r-- | docs/docs/development/clean-room.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/docs/development/clean-room.md b/docs/docs/development/clean-room.md new file mode 100644 index 0000000..82db3a0 --- /dev/null +++ b/docs/docs/development/clean-room.md @@ -0,0 +1,28 @@ +--- +title: Clean Room Implementation +sidebar_label: Clean Room +--- + +:::warning + +Anyone wanting to contribute code to ZMK _MUST_ read this, and adhere to the steps outlines in order to not violate any licenses/copyright of other projects + +::: + +ZMK Firmware is a [clean room design](https://en.wikipedia.org/wiki/Clean_room_design) keyboard firmware, that +borrows/implements a lot of the features found in popular keyboard firmwares projects like [QMK](https://qmk.fm) +and [TMK](https://github.com/tmk/tmk_keyboard). However, in order for ZMK to use the MIT, it _must_ not +incorporate any of the GPL licensed code from those projects. + +In order to achieve this, all code for ZMK has been implemented completely fresh, _without_ referencing, copying, +or duplicating any of the GPL code found in those other projects, even though they are open source software. + +## Contributor Requirements + +Contributors to ZMK must adhere to the following standard. + +- Implementations of features for ZMK _MUST NOT_ reuse any existing code from any projects not licensed with the MIT license. +- Contributors _MUST NOT_ study or refer to any GPL licensed source code while working on ZMK. +- Contributors _MAY_ read the documentation from other GPL licensed projects, to gain a broad understanding of the behavior of certain features in order to implement equivalent features for ZMK. +- Contributors _MAY_ refer to the [QMK Configurator](https://config.qmk.fm/) to inspect existing layouts/keymaps for + keyboards, and re-implement them for ZMK. |