From 6618b91b7ae36552ffecc2fb5ee4663a979df456 Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Thu, 9 Nov 2017 16:27:16 +0100 Subject: doc: describe how to contribute when a GitHub Pull-Request is made gluster-block does not use GitHub Pull-Requests. However not all developers are aware of this, so showing a note whenever someone creates a Pull-Request should inform them. Change-Id: Ibc717a3d578946b1d260c5a7af6e828b810887d1 URL: https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/ Signed-off-by: Niels de Vos --- .github/PULL_REQUEST_TEMPLATE | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..5d91cd3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,30 @@ +Many thanks for your interest in improving gluster-block! + +gluster-block does not use GitHub Pull-Requests. Instead, changes are reviewed +on the Gerrit instance of the Gluster Community at https://review.gluster.org + +In order to send your changes for review, follow these steps: + +1. login on https://review.gluster.org with your GitHub account +2. add a public ssh-key to your profile on https://review.gluster.org/#/settings/ssh-keys +3. add the Gerrit remote to your locally cloned git repository + + $ git remote add gerrit ssh://$USER@review.gluster.org/gluster-block.git + +4. configure the commit hooks + + $ git review --setup + +5. post your changes to Gerrit + + $ git review + + +You may need to install the 'git-review' package if 'git review' is not +available. Note that the hooks for the repository make sure to add a ChangeId +label in the commit messages. Gerrit uses the ChangeId to track single patches +and its updated versions. + +If there are any troubles or difficulties with these instructions, please +contact us on gluster-devel@gluster.org or on Freenode IRC in the #gluster-dev +channel. -- cgit