diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..704cca8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,32 @@ +--- +name: Bug Report +about: Create a report about a feature that isn't working properly +title: BUG - +labels: bug +assignees: '' + +--- + +## Describe the bug +* A clear and concise description of what the bug is. + +## To Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Tap on this button '....' +3. Scroll down to '....' +4. See error + +## Expected behavior +* A clear and concise description of what you expected to happen. + +## Screenshots +* If applicable, add screenshots to help explain your problem. + +## Device Info (please complete the following information): + * Device: [e.g. iPhone14] + * OS: [e.g. iOS 16.0] + * App Version [e.g. v1.5] + +## Additional Context +* Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..d265cfb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,17 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: FEATURE - +labels: feature request +assignees: '' + +--- + +## Describe the feature you want the app to have that it currently doesn't +* A clear and concise description of what you want to happen. + +## Describe alternatives you've considered +* A clear and concise description of any alternative solutions or features you've considered. + +## Additional context +* Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/improve.md b/.github/ISSUE_TEMPLATE/improve.md new file mode 100644 index 0000000..185e9f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve.md @@ -0,0 +1,13 @@ +--- +name: Improve a Feature +about: Create a report to help us improve an existing feature +title: IMPROVE - +labels: improvement +assignees: '' + +--- + +## Describe the feature you want to improve + + +## Describe alternatives you've considered diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ec460c7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +# What it Does +* Closes #issueNumber +* Describe what your change does + +# How I Tested +* Add a list of steps to show the functionality of your feature +For example: +* Run the application +* Tap the (+) button +* See this screen +etc... + +# Notes +* Anything else that should be noted about how you implemented this feature? + +# Screenshot +* Add a screenshot of your new feature! OR show a screen recording of it in action. (On the simulator press Cmd + R to record, and the stop button when done). **This video should be no longer than 30 seconds.** \ No newline at end of file diff --git a/README.md b/README.md index 5c56292..d92ac18 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ This is a simple package that enables you to easily integrate the Memory leaks check to your CI workflow. +# Getting started + +![Static Badge](https://img.shields.io/badge/status-active-brightgreen) + ## Usage Just need to follow these simple steps: @@ -21,8 +25,8 @@ Learn more about `Maestro` [here](https://maestro.mobile.dev/) ## Current support testing frameworks -- [Maestro](https://maestro.mobile.dev/) -- [XCUITest](https://developer.apple.com/documentation/xctest) (In progress) +- [Maestro](https://maestro.mobile.dev/) ✅ +- [XCUITest](https://developer.apple.com/documentation/xctest) (In progress ⚙️) ## How it works @@ -36,9 +40,11 @@ Find more about `leaks` tool and `memgraph` [here](https://developer.apple.com/v ## Why I used Maestro? 1. I need a testing tool which doesn't kill the program after the testing finished execution. And Maestro support that. Also Maestro is very easy to integrate & use. -2. I've tried to used XCUItest, which is really promissing. Based on this [WWDC video](https://developer.apple.com/videos/play/wwdc2021/10180/) from Apple, XCUITest even *allows us to capture the stacktrace where leaks occur & generate a memgraph*. However, I've tried to follow the video but Xcode didn't generate any memgraph. - => I'm working on this. +2. I've tried to used XCUItest, which is really promissing. Based on this [WWDC video](https://developer.apple.com/videos/play/wwdc2021/10180/) from Apple, XCUITest even *allows us to capture the stacktrace where leaks occur & generate a memgraph*. However, I've tried to follow the video but Xcode didn't generate any memgraph. + => I'm working on this. + + I've posted some questions on [swiftforum](https://forums.swift.org/t/xctest-doesnt-generate-memgraph-file-after-ui-test-finish-execution/67982) and [developer.apple](https://developer.apple.com/forums/thread/738659). If you have any ideas, feel free to reply on the threads ## How to support your testing frameworks @@ -73,3 +79,7 @@ It's easy to do that, just need to follow these steps: ## Result + +## Publication + +I've published an article about this on Medium. You can take a look at [here](https://medium.com/gitconnected/automating-memory-leak-detection-with-ci-integration-for-ios-380f08a55f0b) diff --git a/temporary.txt b/temporary.txt deleted file mode 100644 index 1eb2784..0000000 --- a/temporary.txt +++ /dev/null @@ -1,13 +0,0 @@ -leaks Report Version: 4.0 -Process 3651: 42333 nodes malloced for 6720 KB -Process 3651: 4 leaks for 160 total leaked bytes. - - 4 (160 bytes) << TOTAL >> - - 2 (64 bytes) ROOT CYCLE: [32] - 1 (32 bytes) person --> ROOT CYCLE: [32] - apartment --> CYCLE BACK TO [32] - - 1 (48 bytes) ROOT LEAK: [48] - 1 (48 bytes) ROOT LEAK: [48] -