update ceph source to reef 18.1.2

[ceph.git] / ceph / doc / dev / developer_guide / basic-workflow.rst

diff --git a/ceph/doc/dev/developer_guide/basic-workflow.rst b/ceph/doc/dev/developer_guide/basic-workflow.rst
index 53c9c18e8244065e94532881ca5a7ce31bb2d9cd..27000fa2b577be4e6613136371c7b39c58e33e50 100644 (file)
--- a/ceph/doc/dev/developer_guide/basic-workflow.rst
+++ b/ceph/doc/dev/developer_guide/basic-workflow.rst
@@ -43,7 +43,7 @@ no tracker issue exists, create one. There is only one case in which you do not
 have to create a Redmine tracker issue: the case of minor documentation changes.
 
 Simple documentation cleanup does not require a corresponding tracker issue.
-Major documenatation changes do require a tracker issue. Major documentation
+Major documentation changes do require a tracker issue. Major documentation
 changes include adding new documentation chapters or files, and making 
 substantial changes to the structure or content of the documentation.
 
@@ -222,7 +222,7 @@ upstream repository.
 
 The second command (git checkout -b fix_1) creates a "bugfix branch" called
 "fix_1" in your local working copy of the repository. The changes that you make
-in order to fix the bug will be commited to this branch.
+in order to fix the bug will be committed to this branch.
 
 The third command (git push -u origin fix_1) pushes the bugfix branch from
 your local working repository to your fork of the upstream repository.
@@ -398,9 +398,8 @@ determine the cause of your specific failure.
 Integration tests AKA ceph-qa-suite
 -----------------------------------
 
-Since Ceph is complex, it may be necessary to test your fix to
-see how it behaves on real clusters running on physical or virtual
-hardware. Tests designed for this purpose live in the `ceph/qa
+It may be necessary to test your fix on real Ceph clusters that run on physical
+or virtual hardware. Tests designed for this purpose live in the `ceph/qa
 sub-directory`_ and are run via the `teuthology framework`_.
 
 .. _`ceph/qa sub-directory`: https://github.com/ceph/ceph/tree/main/qa/
@@ -410,10 +409,12 @@ sub-directory`_ and are run via the `teuthology framework`_.
 The Ceph community has access to the `Sepia lab
 <https://wiki.sepia.ceph.com/doku.php>`_ where `integration tests`_ can be run
 on physical hardware.
-Other developers may add tags like "needs-qa" to your PR.  This allows PRs that
-need testing to be merged into a single branch and tested all at the same time.
-Since teuthology suites can take hours (even days in some cases) to run, this
-can save a lot of time.
+
+Other contributors might add tags like `needs-qa` to your PR. This allows PRs
+to be merged into a single branch and then efficiently tested together.
+Teuthology test suites can take hours (and even days in some cases) to
+complete, so batching tests reduces contention for resources and saves a lot of
+time.
 
 To request access to the Sepia lab, start `here
 <https://wiki.sepia.ceph.com/doku.php?id=vpnaccess>`_.
@@ -484,6 +485,19 @@ This consists of two parts:
 #. The name and email address of the reviewer. Enclose the reviewer's email 
    address in angle brackets.
 
+Using a browser extension to auto-fill the merge  message
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you use a browser for merging GitHub PRs, the easiest way to fill in
+the merge message is with the `"Ceph GitHub Helper Extension"
+<https://github.com/tspmelo/ceph-github-helper>`_ (available for `Chrome
+<https://chrome.google.com/webstore/detail/ceph-github-helper/ikpfebikkeabmdnccbimlomheocpgkmn>`_
+and `Firefox <https://addons.mozilla.org/en-US/firefox/addon/ceph-github-helper/>`_).
+
+After enabling this extension, if you go to a GitHub PR page, a vertical helper
+will be displayed at the top-right corner. If you click on the user silhouette button
+the merge message input will be automatically populated.
+
 Using .githubmap to Find a Reviewer's Email Address
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If you cannot find the email address of the reviewer on his or her GitHub