Skip to content

Conversation

janz93
Copy link
Contributor

@janz93 janz93 commented Jan 22, 2025

What changes are introduced?

Explain the changes you’ve made. It doesn’t need to be fancy and you don’t have to get to technical, yet. At a high level, this is where you let the reviewer know the overall effect of the PR. Reference a ticket from your issue tracker if possible.

Why are these changes introduced?

The “why” tells us what business or engineering goal this change achieves. It’s the reason we get paid as developers. The “why” is a chance to explain both the engineering goal, but also a some business objective that is satisfied or moved along.

How are these changes made?

Of course, the PR diff will tell most of the story of the “how”, but make sure to draw attention to the significant design decisions. You decided to write a recursive method instead of a loop, pointing out the merits of this will help the reviewer understand your reasoning and in turn provide a better review.

How was it tested? (optional)

remove this section, when you don't add further information

Some code, especially infrastructure code (say HELM or Kubernetes yaml files) are harder to test. So it’s important to let the reviewer know how you tested them in case you can’t check in tests. Alternatively, you can explain to the reviewer how to test it locally if necessary. Showing the results of tests you’ve run in this section if none are visible in the diff is also very helpful.

  • Specs
  • Locally
  • Staging

Hints for Reviews? (optional)

remove this section, when you don't attach further hints

Screenshots, Sample Data
Before After

store invalid import files for later debugging
allow the user to configure the mt940/mt920 parsing individually to the custom needs
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.

1 participant