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

[develop]: Add debugging guide to README.md #519

Merged

Conversation

MichaelLueken
Copy link
Collaborator

DESCRIPTION OF CHANGES:

Ben Brinkley, from EPIC's ECE team, has requested that the link to EPIC's debugging guide be added to the README.md file. This PR adds this link to the README.md file.

Type of change

  • This change is a documentation update to the README.md file.

TESTS CONDUCTED:

None required

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain).
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

CONTRIBUTORS (optional):

Ben Brinkley and EPIC ECE team.

@MichaelLueken
Copy link
Collaborator Author

Closing PR. Need PDF file to be available outside of NOAA-centric Google Doc.

@MichaelLueken
Copy link
Collaborator Author

The EPIC ECE team has hosted their Debugging Guide on the EPIC web site. This version is now being linked in the updated README.md file. Please take a moment and look at the change and approve if you are okay with it. Thanks!

Copy link
Collaborator

@natalie-perlin natalie-perlin left a comment

Choose a reason for hiding this comment

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

Looks good!!

Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA left a comment

Choose a reason for hiding this comment

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

Agreed--looks good!

@MichaelLueken MichaelLueken merged commit 3770ca5 into ufs-community:develop Jan 5, 2023
@MichaelLueken MichaelLueken deleted the text/debug_readme branch January 5, 2023 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants