Feature 2147 workflow doc (#2185)

* Add new images for github workflow * Added PR section * Modified the Find the GitHub Issue to be Find or Create a GitHub issue * Trying out image keyword compared with figure keyword * Trying out various widths * Added new figures * Reverting to figures from images after modifying figures * Adding the old images which are better quality * Trying out new indention * Working on formatting again * Reducing image widths * Update docs/Contributors_Guide/github_workflow.rst Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> * Update docs/Contributors_Guide/github_workflow.rst Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> * Update docs/Contributors_Guide/github_workflow.rst Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> * Update github_workflow.rst --------- Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
dtcenter · May 24, 2023 · 7213ce6 · 7213ce6
1 parent 24b2fa9
commit 7213ce6
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 2 deletions.
diff --git a/docs/Contributors_Guide/figure/1Issue-before-created.png b/docs/Contributors_Guide/figure/1Issue-before-created.png
diff --git a/docs/Contributors_Guide/figure/1PR-before-created.png b/docs/Contributors_Guide/figure/1PR-before-created.png
diff --git a/docs/Contributors_Guide/figure/2Issue-after-created.png b/docs/Contributors_Guide/figure/2Issue-after-created.png
diff --git a/docs/Contributors_Guide/figure/2PR-after-created.png b/docs/Contributors_Guide/figure/2PR-after-created.png
diff --git a/docs/Contributors_Guide/figure/3Issue-set-status.png b/docs/Contributors_Guide/figure/3Issue-set-status.png
diff --git a/docs/Contributors_Guide/figure/3PR-set-status.png b/docs/Contributors_Guide/figure/3PR-set-status.png
diff --git a/docs/Contributors_Guide/figure/4Issue-plus-one-set-cycle.png b/docs/Contributors_Guide/figure/4Issue-plus-one-set-cycle.png
diff --git a/docs/Contributors_Guide/figure/4PR-plus-one-set-cycle.png b/docs/Contributors_Guide/figure/4PR-plus-one-set-cycle.png
diff --git a/docs/Contributors_Guide/figure/5PR-link-issue.png b/docs/Contributors_Guide/figure/5PR-link-issue.png
diff --git a/docs/Contributors_Guide/github_workflow.rst b/docs/Contributors_Guide/github_workflow.rst
@@ -324,8 +324,8 @@ Detailed instructions for each item can be found below or by clicking the link.
 
 .. _wo-find-issue:
 
-Find the GitHub issue
-^^^^^^^^^^^^^^^^^^^^^
+Find or Create a GitHub Issue
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * Go to the `METplus repository <https://github.com/dtcenter/METplus>`_  and
   click on the `Issues tab <https://github.com/dtcenter/METplus/issues>`_.
@@ -336,6 +336,46 @@ Find the GitHub issue
   `new Discussion <https://github.com/dtcenter/METplus/discussions/new>`_ on
   the METplus GitHub Discussions page to ask if an issue should be created.
 
+* If creating a new issue, select the
+  `"New Issue" <https://github.com/dtcenter/METplus/issues/new/choose>`_ button
+  and review the categories of issues (e.g. Bug report, enhancement request,
+  New feature request, New use case, Sub-Issue, Task).  Find an appropriate
+  categories and click on "Get Started" next to the category.
+
+  Create a short, but descriptive title. In the 'write' window, follow the
+  directions and fill in the template.  Add any additional comments/details.
+  When filling in the template, be sure to "Define the PR metadata, as
+  permissions allow. Select: **Assignee(s), Project(s)**, and **Milestone**". 
+
+  Before an issue is created, a "Project" can be selected, but there is no
+  option to select a cycle.
+
+  .. image:: figure/1Issue-before-created.png
+    :width: 400	     
+
+  After the issue is created, more options appear under the "Project" section.
+
+  .. image:: figure/2Issue-after-created.png
+    :width: 400
+
+  Click the "Status" drop down and select "Todo".
+
+  .. image:: figure/3Issue-set-status.png
+    :width: 400
+
+  Click on "+1 more" then under "Cycle", click "Choose an iteration" and
+  select the current development cycle.
+
+  .. image:: figure/4Issue-plus-one-set-cycle.png
+    :width: 400
+
+  After selecting the appropriate "Cycle", be sure to remove the
+  **alert: NEED CYCLE ASSIGNMENT** label, which is added by default.
+
+  If the description of the issue is clear and does not need further
+  definition, be sure to remove the **alert: NEED MORE DEFINITION**
+  label, which is added by default.
+
 .. _wo-fork-repo:
 
 Fork the dtcenter/METplus repository
@@ -672,6 +712,29 @@ Open a pull request
     * When everything looks satisfactory, click on the green 'Create pull
       request' button.
 
+    * Before a pull request is created, a "Project" can be selected, but there
+      is no option to select a cycle.
+
+      .. figure:: figure/1PR-before-created.png
+
+      After the pull request is created, more options appear under the
+      "Project" section.
+
+      .. figure:: figure/2PR-after-created.png
+
+      Click the "Status" drop down and select "Review".
+
+      .. figure:: figure/3PR-set-status.png
+
+      Click on "+1 more" then under "Cycle", click "Choose an iteration" and
+      select the current development cycle.
+
+      .. figure:: figure/4PR-plus-one-set-cycle.png
+
+      To link the issue that correspondes to the pull request, click on the
+      gear next to "Development," type the issue number, then select the issue
+      that is displayed.
+
     * An authorized METplus developer will accept the pull request (if
       everything meets acceptance criteria) and merge the code into the remote
       repository's develop branch.