Merge pull request #1 from gioviebell/gioviebell-patch-1

gioviebell · web-flow · commit a11f27372035 · 2025-08-10T18:36:47.000-05:00
GH-931: Update pull-request-lifecycle.rst PR title and description section
diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst
@@ -213,24 +213,28 @@ should do to help ensure that your pull request is accepted.
       the other hand, fixes for typos and grammar errors in documents and
       docstrings are welcome.
 
-#. **Follow best practices when creating the PR title and description.** The 
-   pull requests title and description play a pivotal role in code review and 
+#. **Follow best practices when creating the PR title and description.** The
+   pull requests title and description play a pivotal role in code review and
    issue resolution. It is the initial point of contact in a code review, and 
    allows the code reviewer to quickly assess the issue. The suggested formatting
-   of the title and description is 
-   **[type(optional) title: description (issue number)]** where type is the label
-   associated with the issue being resolved. Based on `Best practices for 
-   writing good pull request titles`_, a pull request title should be descriptive but   
-   to the point. It should establish a clear yet brief summary, so to allow the code 
-   reviewer to quickly assess the pull request. 
-   The description should explain what was changed in the pull request, why it exists, 
-   and explain the process of what was done in the pull request. 
-   Here is an example of a poor and revised pull request description: 
-      **Poor Pull Request:** "update code" **Revised Pull Request:** 
+   of the title and description is
+
+      **GH-issue number: brief description of what the pull request resolves**
+
+      **Example: GH-123456: Use pure op machinery to optimize various instructions
+      with _POP_TOP and _POP_TWO**
+
+   Based on `Best practices for writing good pull request titles`_, a pull request 
+   title should be descriptive but to the point. It should establish a clear yet brief
+   summary, so to allow the code reviewer to quickly assess the pull request.
+   The description should explain what was changed in the pull request, why it exists,
+   and explain the process of what was done in the pull request.
+   Here is an example of a poor and revised pull request description:
+      **Poor Pull Request:** "update code" **Revised Pull Request:**
       "feat: add search functionality to user dashboard(closes #111)"
 
-   For more examples on writing a good pull request title, please take a look at 
-   `Best practices for 
+   For more examples on writing a good pull request title, please take a look at
+   `Best practices for
    writing good pull request titles`_
 
    To read more on creating a descriptive pull request description, please review
