Coder Social home page Coder Social logo

ios-pr-checklist's Introduction

iOS Pull Request Checklist

General

  • Did I remove any extraneous self references? [Swift only]
  • If you added a default case to a switch, are you absolutely sure that's the ideal solution?
  • Am I duplicating existing code?
  • Did you specify the correct access level for any of the new entities you introduced?
  • Is everything behind a feature flag that should be?
  • Am I force unwrapping anything?
  • Did I resolve any ambiguous constraints / handle any breaking constraint at runtime issues?
  • Am I introducing any unnecessary import statements?
  • Did I document everything that I needed to?
  • Am I introducing any long running operations on the main thread?
  • Am I using any "magic numbers"? Should I add them to our constants?
  • Am I following the teams coding conventions throughout my changes?
  • Did I receive design and product approval?
  • Could any of my new code be replaced by native functions or existing helper functions?
  • Did I chose appropriate names for my classes, enums, structs, methods, and variables?
  • Am I handling and logging all errors correctly?

Testing

  • Are there tests? Should there be?
  • Did I test different locales and languages? Did the currency, time, and date formatting work as expected?
  • Did I test night mode support or remember to disable it?
  • Did I test for memory leaks? Did I make everything weak that should be?
  • Did I test multiple screen sizes and orientations?
  • Did I test on the lowest iOS version we support?
  • Did I test what happens if the user declines / limits permission access (location, camera roll, contacts, etc)?
  • Did I test for accessibility compatibility?
  • Did I test a poor or offline WiFi connection?
  • Did I test what happens if the API calls fail?
  • Do the existing tests (unit & UI) pass?
  • Did I test with Double Length Pseudolanguage to ensure that text wraps and can accommodate more verbose languages?
  • Did I test other languages we support to ensure there's no missing translations?

Creating A Pull Request

  • Am I introducing any new warnings into the Xcode project?
  • Did I pull in master and resolve any merge conflicts before opening a pull request?
  • Does linting pass?
  • Does my PR include screenshots and instructions on how to test these changes?
  • Did I remove any commented out code?
  • Did I remove all TODO@hack, and placeholder code?
  • Did I remove all of the print statements I was using? Am I doing any unnecessary logging?
  • Does my PR include testing instructions, a description, and a link to the ticket?

ios-pr-checklist's People

Contributors

aryamansharda avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.