From b4b1356bdd2b589124bd86ff332cdcdbe84d8a24 Mon Sep 17 00:00:00 2001 From: Arksine Date: Mon, 27 Jul 2020 18:27:23 -0400 Subject: [PATCH] docs: Add contributing guidelines Signed-off-by: Eric Callahan --- docs/contributing.md | 31 +++++++++++++++++++++++ docs/developer-certificate-of-origin | 37 ++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 docs/contributing.md create mode 100644 docs/developer-certificate-of-origin diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..3c166ce --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,31 @@ +# Contributing to Moonraker + +While Moonraker exists as a service independently from Klipper, it relies +on Klipper to be useful. Thus, the tentative plan is to eventually merge +the Moonraker application into the Klipper repo after Moonraker matures, +at which point this repo will be archived. As such, contibuting guidelines +are near those of Klipper: + +- All source files should begin with a copyright notice in the following + format: + ``` + # Module name and brief description of module + # + # Copyright (C) 2020 YOUR NAME + # + # This file may be distributed under the terms of the GNU GPLv3 license + ``` +- No line in the source code or documentation should exceed 80 characters. + Be sure there is no trailing whitespace. +- Each Commit message should be in the following format: + ``` + module name: brief description of commit + + More detailed explanation if necessary. + + Signed-off-by: Your Name + ``` +- By signing off on commits, you acknowledge that you agree to the + [developer certificate of origin](developer-certificate-of-origin). + As with Klipper, this must contain your real name and a current + email address. diff --git a/docs/developer-certificate-of-origin b/docs/developer-certificate-of-origin new file mode 100644 index 0000000..8201f99 --- /dev/null +++ b/docs/developer-certificate-of-origin @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved.