Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature 2147 workflow doc #2185

Merged
merged 15 commits into from
May 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Contributors_Guide/figure/3PR-set-status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Contributors_Guide/figure/5PR-link-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 65 additions & 2 deletions docs/Contributors_Guide/github_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down