Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hoangatuan committed Oct 22, 2023
1 parent 79fc6ef commit 7981d7e
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 17 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/improve.md
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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.**
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -73,3 +79,7 @@ It's easy to do that, just need to follow these steps:
## Result

<img src=resources/result.png width=800/>

## 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)
13 changes: 0 additions & 13 deletions temporary.txt

This file was deleted.

0 comments on commit 7981d7e

Please sign in to comment.