Versions Compared

Version Old Version 24 New Version Current
Changes made by

Walter Moar

Walter Moar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Code changes that maintain the exist existing code’s design and style

  • Code changes that do not decrease test coverage or maintainability

  • Commit messages and Pull Requests that are in a consistent format

  • Pull Requests that are easy and fast to review to avoid review bottlenecks

...

Expand
titleWhy this is recommended

This is a chance to do a self-review of your changes before creating the PR

  • are the changes too big (too many files, too many lines) to be easily and quickly reviewed?

  • is the Pull Request doing too many different things? Can it be broken down into smaller PRs?

  • did reading the code remind you of work you forgot to do?

  • did you leave yourself ‘todo’ items that need to be completed?

  • is every changed line necessary? Was anything accidentally committed?

  • are there tests to cover the code changes / additions?

  • are there documentation updates for the code changes / additions?

...