Skip to main content
Software Engineering

You are not logged in. Your edit will be placed in a queue until it is peer reviewed.

We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.

Required fields*

7
  • 31
    2a) Automate linting so it doesn't need to be done manually during code review. Commented Dec 4, 2023 at 23:04
  • 2
    excellent point @Bergi an automated CI/CD system like Jenkins would ideally be linting and running unit tests Commented Dec 4, 2023 at 23:08
  • 9
    10) Think about how this code scales, eg what would happen it usages increases 10x or 100x. A reasonable amount of futureproofness should exists Commented Dec 5, 2023 at 9:02
  • 6
    11) Keep an eye out for deviations from the company's coding style guide which aren't covered by Lint - e.g. naming conventions. Commented Dec 5, 2023 at 10:10
  • 2
    0. Make sure you understand what the code does (or is supposed to be doing). 6a. Make sure the code is "defensive". What happens if there is an error? What happens if the input is not in the expected format or something is missing? Make sure input is not trusted. 6a. Look for duplicated code (in the addition, and compared to the existing code) 12. What happens when input strings stray out of pure ASCII? When a french user types an accent, or someone types an Emoji? Or one of <>&'"$!%? For text inputs and outputs, what are they supposed to be? Actual text, or HTML? Commented Dec 5, 2023 at 15:27