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

Fix a typo in the resilience metric Engineering Reference #8754

Merged
merged 1 commit into from
May 19, 2021

Conversation

xuanluo113
Copy link
Contributor

@xuanluo113 xuanluo113 commented May 5, 2021

Pull request overview

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@xuanluo113 xuanluo113 added the Documentation Related primarily on the LaTeX-based EnergyPlus documentation label May 5, 2021
@xuanluo113 xuanluo113 added this to the EnergyPlus Future milestone May 5, 2021
@xuanluo113 xuanluo113 requested a review from Myoldmopar May 5, 2021 20:59
@xuanluo113 xuanluo113 self-assigned this May 5, 2021
@xuanluo113 xuanluo113 added the Defect Includes code to repair a defect in EnergyPlus label May 5, 2021
@mitchute
Copy link
Collaborator

I've confirmed the changes in the docs now reflect what is in the code. I've also merge develop into this branch locally and confirmed that the Eng Ref builds. This is good to go, and there's no need to spend more CI cycles on this. Merging.

@mitchute mitchute merged commit 69e789c into develop May 19, 2021
@mitchute mitchute deleted the fix-resilience-metric-doc branch May 19, 2021 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typos in Heat Index calculation
7 participants