🤯
Michaelpedia
  • Initial page
  • Pull Request Checklist
  • Git
  • MySQL
  • iOS
    • Typography
Powered by GitBook
On this page
  • Correct code
  • Performance and Optimization
  • Security and errors
  • Neatness and syntax
  • Dead code

Was this helpful?

Pull Request Checklist

Correct code

  • Did you build and run the code?

  • Does the code work as expected?

  • Is the code as simple as possible?

  • Do all the tests pass, and were they updated if necessary for the specified changes?

  • When adding new features, did you add new tests?

  • If this fixes a bug, is the bug actually fixed?

  • If this fixes a bug, did you a test that demonstrates the error and tests for it?

  • Does this break any related behavior, or bring back old bugs?

  • Did you fix any related TODOs or FIXMEs?

  • Did you document any missing functionality that will be added later, creating additional tickets as necessary?

  • If the project is set up for internationalization, are all new strings marked for translation?

Performance and Optimization

  • Does the code perform well on the target device (if the target device is mobile)?

  • Does the code introduce any performance regressions?

  • Are there any obvious optimizations that can be made?

Security and errors

  • Are all inputs to a method properly sanitized?

  • Are there any potential edge cases that aren't being handled?

  • Did you fix any warnings related to your changes?

Neatness and syntax

  • Does the commit message correctly explain the changes, and why they are being made?

  • Could the commit be broken into separate chunks?

  • Are all related comments up to date and as clear as possible?

  • Are all variable and method names as clear as possible?

  • Were all variable names and strings spell-checked?

  • Does the code follow any project formatting or structure guidelines?

    • For Javascript code, ideally the project should have an ESLint configuration that you can use.

Dead code

  • Did you remove any now-obsolete code?

  • Remove any temporary log statements

  • Remove any commented out code

  • Do the remaining log statements serve a good purpose? Could they be replaced by actual error checking?

Pause and read through the diff and commit message.

PreviousInitial pageNextGit

Last updated 1 year ago

Was this helpful?

Does the commit message follow any project guidelines (, etc.)?

For Python code, use to ensure the code passes PyFlakes and PEP 8 guidelines.

Conventional Changelog
flake8