From 6baa79b17337bb9fd8aa95e4f8c743ab4111aa75 Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Mon, 22 Jan 2018 11:08:48 +0100 Subject: doc: describe how to contribute when a GitHub Pull-Request is made Every now and then new contributors create a GitHub Pull-Request. We do not use those for accepting changes, and almost never check for new PRs. Redirecting contributors can be done automatically, just like we do when users create a GitHub Issue. Note that the bulk of the description comes from gluster-block. Just like most Gerrit maintained projects, it uses 'git review' and not a custom ./rfc.sh. New contributors that are familiar with Gerrit, will prefer the 'git review' approach over ./rfc.sh (which we want to deprecate or at least have it use 'git review' too). Change-Id: Ide36cbd80fdaaf238ea35ae5932a0cd21fc41f36 Updates: #381 URL: https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/ Signed-off-by: Niels de Vos --- .github/PULL_REQUEST_TEMPLATE | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE (limited to '.github') diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 00000000000..0ec6eb319ee --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,33 @@ +Many thanks for your interest in improving GlusterFS! + +GlusterFS 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/glusterfs.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. + +For more details, see the documented development workflow at + http://gluster.readthedocs.io/en/latest/Developer-guide/Simplified-Development-Workflow/ + +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