Today I Learned: collection of notes, tips and tricks and stuff I learn from day to day working with computers and technology as an open source contributor and product manager

View project on GitHub

Providing Suggestions in Reviews

When doing code reviews on GitHub you can provide suggestions in your comments.

Like so:

Suggested change

It is important that the indentation matches, an example:

Original code:

  # This is an important bit - if you don't do the find the decode
  # will randomly fail/succeed.  This is required to work
  my $asn_node = $asn->find("SubjectAltName")

Review comment:

Please use single-quotes for literals as suggested by Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals

  my $asn_node = $asn->find('SubjectAltName')

This will make it easier to apply the suggested change.

Resources and References

  1. GitHub Docs: “Incorporating feedback in your pull request”