# BugShaker

**Repository Path**: cmzl_ohos/bugshaker

## Basic Information

- **Project Name**: BugShaker
- **Description**: BugShaker允许你的QA团队和/或最终用户通过晃动他们的设备来轻松提交bug报告
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-07-12
- **Last Updated**: 2024-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BugShaker
Shake to send a bug report!

# Development Status

**Maintained**

- Not currently under active development.
- Active development may resume in the future.
- Bug reports will be triaged and fixed. No guarantees are made regarding fix timelines.
- Feature requests will be triaged. No guarantees are made regarding acceptance or implementation timelines.
- Pull requests from external contributors are not currently being accepted.

# Introduction

BugShaker allows your QA team and/or end users to easily submit bug reports by shaking their device. When [a shake is detected]((https://github.com/square/seismic)), the current screen state is captured and the user is prompted to submit a bug report via email with this screenshot attached.


## Screenshots

![bugShaker](screenShoot/bugShaker.gif)

## Installation 
##### way-1: use package har
```
Packages up your library into a har，and add the har to the directory entry libs,

Add implementation codes to directory entry/gradle:
implementation fileTree(dir: 'libs', include: ['*.jar', '*.har'])
```

##### way-2: use gradle
```
allprojects{
    repositories{
        mavenCentral()
    }
}
implementation 'com.gitee.archermind-ti:bugshaker:1.0.0-beta'

```

## HOW TO USE

- Configure the shared `BugShaker` instance in your BaseAbilitySlice, then call assemble and start to begin listening for shakes:

   ```java
   public class BaseAbilitySlice extends AbilitySlice {
       private  void  applicationfangfa(AbilitySlice abilitySlice)
            {
                try {
                    BugShaker.get(abilitySlice)
                            .setEmailAddresses("someone@example.com")
                            .setEmailSubjectLine("BugShaker OpenHarmony App Feedback")
                            .setLoggingEnabled(BuildConfig.DEBUG)
                            .setAlertDialogType(IDialogType.APP_COMPAT)
                            .assemble()
                            .start();
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
   }
   ```

It is recommended that logging always be disabled in production builds.

## Advanced Usage

If you would like to customize the alert dialog presented to users when a shake is detected, update your BugShaker configuration as follows:

- Modifying layout in bugshaker
- dialog.xml Configure the information to modify


## Unfinished
- For the permisstion of screen capture is unsupport,the screen capture methods is not completed.


#### License

```
Copyright 2016 Stuart Kent

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

```