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

Global Cleanup #8318

Merged
merged 18 commits into from
Sep 29, 2020
Merged

Global Cleanup #8318

merged 18 commits into from
Sep 29, 2020

Conversation

mitchute
Copy link
Collaborator

Pull request overview

  • PR removes passing lower-level classes as arguments and falls back to passing the state argument everywhere.

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

@mitchute mitchute added the Refactoring Includes code changes that don't change the functionality of the program, just perform refactoring label Sep 29, 2020
@mitchute mitchute added this to the EnergyPlus Future milestone Sep 29, 2020
@mitchute mitchute self-assigned this Sep 29, 2020
@Myoldmopar
Copy link
Member

Assuming this comes back clean it will be fine to drop in next.

@Myoldmopar
Copy link
Member

So far so good...

@Myoldmopar
Copy link
Member

I'll let Windows finish then drop this in.

@Myoldmopar
Copy link
Member

All green! Looks great. Merging.

@Myoldmopar Myoldmopar merged commit 30df506 into develop Sep 29, 2020
@Myoldmopar Myoldmopar deleted the global_cleanup branch September 29, 2020 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Refactoring Includes code changes that don't change the functionality of the program, just perform refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants