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 #2207 Documentation - Updates to Contributor's Guide #2263

Merged
merged 3 commits into from
Jul 25, 2023

Conversation

georgemccabe
Copy link
Collaborator

Pull Request Testing

  • Describe testing already performed for these changes:

N/A

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

Review changes to docs:

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

  • Do these changes include sufficient testing updates? [Yes]

N/A

  • Will this PR result in changes to the test suite? [No]

  • Please complete this pull request review by 7/28/2023.

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Development issue with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

…d in the issue comments to improve the clarity of the instructions
@georgemccabe georgemccabe added this to the METplus-5.1.0 milestone Jul 24, 2023
@georgemccabe georgemccabe linked an issue Jul 24, 2023 that may be closed by this pull request
22 tasks
Copy link
Contributor

@j-opatz j-opatz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes made seem to clear up a few confusing commands from the original material, and correct at least 1 spelling mistake.

The PR is approved.

Copy link
Contributor

@DanielAdriaansen DanielAdriaansen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small change to force the copy lines to occur in a code block otherwise looks great. Thanks in particular for adapting the github workflow section to better distinguish between branches and forks. It's much improved IMHO @georgemccabe!

@georgemccabe georgemccabe merged commit 6b4f8a5 into develop Jul 25, 2023
@georgemccabe georgemccabe deleted the feature_2207_doc_contrib_updates branch July 25, 2023 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Improve Contributor's Guide during When working on #2198
3 participants