From c35f6aa9efee75c086f604e014e0a0f015fd65b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Sat, 4 Mar 2017 12:47:26 +0100 Subject: [PATCH] Add contribution guidelines to README --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index f4f27a32c..83651e2fe 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,47 @@ Make sure you have installed the dependencies with ```make install-deps```. Afte You can use the provided Makefile to run all tests by using: make test + + + +## Contribution Guidelines + +Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. + +For more information please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md) to this repository. + +### Apply a license + +All contributions to this repository are considered to be licensed under +the GNU AGPLv3 or any later version. + +Contributors to the Spreed app retain their copyright. Therefore we recommend +to add following line to the header of a file, if you changed it substantially: + +``` +@copyright Copyright (c) , () +``` + +For further information on how to add or update the license header correctly please have a look at [our licensing HowTo][applyalicense]. + +### Sign your work + +We use the Developer Certificate of Origin (DCO) as a additional safeguard +for the Nextcloud project. This is a well established and widely used +mechanism to assure contributors have confirmed their right to license +their contribution under the project's license. +Please read [developer-certificate-of-origin][dcofile]. +If you can certify it, then just add a line to every git commit message: + +```` + Signed-off-by: Random J Developer +```` + +Use your real name (sorry, no pseudonyms or anonymous contributions). +If you set your `user.name` and `user.email` git configs, you can sign your +commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases) +like `git config --global alias.ci 'commit -s'`. Now you can commit with +`git ci` and the commit will be signed. + +[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin +[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md