├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 aryamansharda 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # iOS Pull Request Checklist 2 | 3 | ## **General** 4 | 5 | * [ ] Did I remove any extraneous `self` references? [Swift only] 6 | * [ ] If you added a `default` case to a `switch`, are you absolutely sure that's the ideal solution? 7 | * [ ] Am I duplicating existing code? 8 | * [ ] Did you specify the correct access level for any of the new entities you introduced? 9 | * [ ] Is everything behind a feature flag that should be? 10 | * [ ] Am I force unwrapping anything? 11 | * [ ] Did I resolve any ambiguous constraints / handle any breaking constraint at runtime issues? 12 | * [ ] Am I introducing any unnecessary `import` statements? 13 | * [ ] Did I document everything that I needed to? 14 | * [ ] Am I introducing any long running operations on the main thread? 15 | * [ ] Am I using any "magic numbers"? Should I add them to our constants? 16 | * [ ] Am I following the teams coding conventions throughout my changes? 17 | * [ ] Did I receive design and product approval? 18 | * [ ] Could any of my new code be replaced by native functions or existing helper functions? 19 | * [ ] Did I chose appropriate names for my classes, enums, structs, methods, and variables? 20 | * [ ] Am I handling and logging all errors correctly? 21 | 22 | ## **Testing** 23 | 24 | * [ ] Are there tests? Should there be? 25 | * [ ] Did I test different locales and languages? Did the currency, time, and date formatting work as expected? 26 | * [ ] Did I test night mode support or remember to disable it? 27 | * [ ] Did I test for memory leaks? Did I make everything `weak` that should be? 28 | * [ ] Did I test multiple screen sizes and orientations? 29 | * [ ] Did I test on the lowest iOS version we support? 30 | * [ ] Did I test what happens if the user declines / limits permission access (location, camera roll, contacts, etc)? 31 | * [ ] Did I test for accessibility compatibility? 32 | * [ ] Did I test a poor or offline WiFi connection? 33 | * [ ] Did I test what happens if the API calls fail? 34 | * [ ] Do the existing tests (unit & UI) pass? 35 | * [ ] Did I test with `Double Length Pseudolanguage` to ensure that text wraps and can accommodate more verbose languages? 36 | * [ ] Did I test other languages we support to ensure there's no missing translations? 37 | 38 | ## **Creating A P**ull Request 39 | 40 | * [ ] Am I introducing any new warnings into the Xcode project? 41 | * [ ] Did I pull in `main` and resolve any merge conflicts before opening a pull request? 42 | * [ ] Does linting pass? 43 | * [ ] Does my PR include screenshots and instructions on how to test these changes? 44 | * [ ] Did I remove any commented out code? 45 | * [ ] Did I remove all `TODO`, `@hack`, and placeholder code? 46 | * [ ] Did I remove all of the `print` statements I was using? Am I doing any unnecessary logging? 47 | * [ ] Does my PR include testing instructions, a description, and a link to the ticket? 48 | --------------------------------------------------------------------------------