From 1137aca417efc462ca3723495bf74f167b2be38c Mon Sep 17 00:00:00 2001 From: Raheman Vaiya Date: Mon, 2 Aug 2021 01:15:39 -0400 Subject: [PATCH] Added CONTRIBUTING --- CONTRIBUTING | 7 +++++++ README.md | 4 ++++ 2 files changed, 11 insertions(+) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..964d927 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,7 @@ +The best way to contribute is to file an issue with any bugs you find or any +features you think belong in keyd. Small issues pertaining to things like +compilation on different platforms can be submitted as PRs but please avoid +sending in patches which change core functionality without filing an issue +first. The key logic can be deceptively simple and contains a few subtleties +that need to be managed properly. Additionally, I reserve the right to reject +any features which I do not think belong in keyd. diff --git a/README.md b/README.md index c1155bb..62f2d47 100644 --- a/README.md +++ b/README.md @@ -162,3 +162,7 @@ on github. keyd has a minimalist (but sane) design philosophy which intentionally omits certain features (e.g unicode/execing arbitrary executables as root). Things which already exist in custom keyboard firmware like QMK are good candidates for inclusion. + +# Contributing + +See [CONTRIBUTING].